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

Resource Profile: Profile_R5_Account_R4 - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-Account resource profile.

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

0. Account
Definition

A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.

ShortTracks balance, charges, for patient or cost center
Control0..*
Is Modifierfalse
Summaryfalse
Alternate NamesCost center, Record
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Account.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
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()))
4. Account.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. 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..*
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 Account.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. Account.extension:billingStatus
    Slice NamebillingStatus
    Definition

    R5: Account.billingStatus (new:CodeableConcept)

    ShortR5: Tracks the lifecycle of the account through the billing process (new)
    Comments

    Element Account.billingStatus has a context of Account based on following the parent source element upwards and mapping to Account. Element Account.billingStatus has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: Tracks the lifecycle of the account through the billing process (new)) (Extension Type: CodeableConcept)
    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())
    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())
    8. Account.extension:diagnosis
    Slice Namediagnosis
    Definition

    R5: Account.diagnosis (new:BackboneElement)

    ShortR5: The list of diagnoses relevant to this account (new)
    Comments

    Element Account.diagnosis has a context of Account based on following the parent source element upwards and mapping to Account. Element Account.diagnosis 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
    TypeExtension(R5: The list of diagnoses relevant to this account (new)) (Complex Extension)
    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())
    10. Account.extension:procedure
    Slice Nameprocedure
    Definition

    R5: Account.procedure (new:BackboneElement)

    ShortR5: The list of procedures relevant to this account (new)
    Comments

    Element Account.procedure has a context of Account based on following the parent source element upwards and mapping to Account. Element Account.procedure 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
    TypeExtension(R5: The list of procedures relevant to this account (new)) (Complex Extension)
    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())
    12. Account.extension:relatedAccount
    Slice NamerelatedAccount
    Definition

    R5: Account.relatedAccount (new:BackboneElement)

    ShortR5: Other associated accounts related to this account (new)
    Comments

    Element Account.relatedAccount has a context of Account based on following the parent source element upwards and mapping to Account. Element Account.relatedAccount 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
    TypeExtension(R5: Other associated accounts related to this account (new)) (Complex Extension)
    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())
    14. Account.extension:currency
    Slice Namecurrency
    Definition

    R5: Account.currency (new:CodeableConcept)

    ShortR5: The base or default currency (new)
    Comments

    Element Account.currency has a context of Account based on following the parent source element upwards and mapping to Account. Element Account.currency has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: The base or default currency (new)) (Extension Type: CodeableConcept)
    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())
    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())
    16. Account.extension:balance
    Slice Namebalance
    Definition

    R5: Account.balance (new:BackboneElement)

    ShortR5: Calculated account balance(s) (new)
    Comments

    Element Account.balance has a context of Account based on following the parent source element upwards and mapping to Account. Element Account.balance 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
    TypeExtension(R5: Calculated account balance(s) (new)) (Complex Extension)
    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())
    18. Account.extension:calculatedAt
    Slice NamecalculatedAt
    Definition

    R5: Account.calculatedAt (new:instant)

    ShortR5: Time the balance amount was calculated (new)
    Comments

    Element Account.calculatedAt has a context of Account based on following the parent source element upwards and mapping to Account. Element Account.calculatedAt has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). The total(s) are not typically updated using the restful API but more often by back-end processes included in a typical finance system.

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: Time the balance amount was calculated (new)) (Extension Type: instant)
    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())
    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())
    20. Account.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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
    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 resource that contains them
    Summaryfalse
    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
    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())
    22. Account.status
    Definition

    Indicates whether the account is presently used/usable or not.

    Shortactive | inactive | entered-in-error | on-hold | unknown
    Comments

    This element is labeled as a modifier because the status contains the codes inactive and entered-in-error that mark the Account as not currently valid.

    Control1..1
    BindingThe codes SHALL be taken from AccountStatushttp://hl7.org/fhir/ValueSet/account-status|4.0.1
    (required to http://hl7.org/fhir/ValueSet/account-status|4.0.1)

    Indicates whether the account is available to be used.

    Typecode
    Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    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. Account
    2. Account.extension
    Control0..*
    SlicingThis element introduces a set of slices on Account.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 4. Account.extension:billingStatus
      Slice NamebillingStatus
      Definition

      R5: Account.billingStatus (new:CodeableConcept)

      ShortR5: Tracks the lifecycle of the account through the billing process (new)
      Comments

      Element Account.billingStatus has a context of Account based on following the parent source element upwards and mapping to Account. Element Account.billingStatus has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      Control0..1
      TypeExtension(R5: Tracks the lifecycle of the account through the billing process (new)) (Extension Type: CodeableConcept)
      6. Account.extension:diagnosis
      Slice Namediagnosis
      Definition

      R5: Account.diagnosis (new:BackboneElement)

      ShortR5: The list of diagnoses relevant to this account (new)
      Comments

      Element Account.diagnosis has a context of Account based on following the parent source element upwards and mapping to Account. Element Account.diagnosis has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      Control0..*
      TypeExtension(R5: The list of diagnoses relevant to this account (new)) (Complex Extension)
      8. Account.extension:procedure
      Slice Nameprocedure
      Definition

      R5: Account.procedure (new:BackboneElement)

      ShortR5: The list of procedures relevant to this account (new)
      Comments

      Element Account.procedure has a context of Account based on following the parent source element upwards and mapping to Account. Element Account.procedure has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      Control0..*
      TypeExtension(R5: The list of procedures relevant to this account (new)) (Complex Extension)
      10. Account.extension:relatedAccount
      Slice NamerelatedAccount
      Definition

      R5: Account.relatedAccount (new:BackboneElement)

      ShortR5: Other associated accounts related to this account (new)
      Comments

      Element Account.relatedAccount has a context of Account based on following the parent source element upwards and mapping to Account. Element Account.relatedAccount has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      Control0..*
      TypeExtension(R5: Other associated accounts related to this account (new)) (Complex Extension)
      12. Account.extension:currency
      Slice Namecurrency
      Definition

      R5: Account.currency (new:CodeableConcept)

      ShortR5: The base or default currency (new)
      Comments

      Element Account.currency has a context of Account based on following the parent source element upwards and mapping to Account. Element Account.currency has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      Control0..1
      TypeExtension(R5: The base or default currency (new)) (Extension Type: CodeableConcept)
      14. Account.extension:balance
      Slice Namebalance
      Definition

      R5: Account.balance (new:BackboneElement)

      ShortR5: Calculated account balance(s) (new)
      Comments

      Element Account.balance has a context of Account based on following the parent source element upwards and mapping to Account. Element Account.balance has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      Control0..*
      TypeExtension(R5: Calculated account balance(s) (new)) (Complex Extension)
      16. Account.extension:calculatedAt
      Slice NamecalculatedAt
      Definition

      R5: Account.calculatedAt (new:instant)

      ShortR5: Time the balance amount was calculated (new)
      Comments

      Element Account.calculatedAt has a context of Account based on following the parent source element upwards and mapping to Account. Element Account.calculatedAt has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). The total(s) are not typically updated using the restful API but more often by back-end processes included in a typical finance system.

      Control0..1
      TypeExtension(R5: Time the balance amount was calculated (new)) (Extension Type: instant)

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

      0. Account
      Definition

      A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.

      ShortTracks balance, charges, for patient or cost center
      Control0..*
      Is Modifierfalse
      Summaryfalse
      Alternate NamesCost center, Record
      Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
      dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
      dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
      dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
      dom-6: A resource should have narrative for robust management (text.`div`.exists())
      2. Account.id
      Definition

      The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

      ShortLogical id of this artifact
      Comments

      The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

      Control0..1
      Typeid
      Is Modifierfalse
      Summarytrue
      4. Account.meta
      Definition

      The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

      ShortMetadata about the resource
      Control0..1
      TypeMeta
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      6. Account.implicitRules
      Definition

      A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

      ShortA set of rules under which this content was created
      Comments

      Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

      Control0..1
      Typeuri
      Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      8. Account.language
      Definition

      The base language in which the resource is written.

      ShortLanguage of the resource content
      Comments

      Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

      Control0..1
      BindingThe codes SHOULD be taken from CommonLanguages .
      (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

      A human language.

      Additional BindingsPurpose
      AllLanguagesMax Binding
      Typecode
      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()))
      10. Account.text
      Definition

      A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

      ShortText summary of the resource, for human interpretation
      Comments

      Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

      Control0..1
      TypeNarrative
      Is Modifierfalse
      Summaryfalse
      Alternate Namesnarrative, html, xhtml, display
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      12. Account.contained
      Definition

      These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

      ShortContained, inline Resources
      Comments

      This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

      Control0..*
      TypeResource
      Is Modifierfalse
      Summaryfalse
      Alternate Namesinline resources, anonymous resources, contained resources
      14. Account.extension
      Definition

      An Extension

      ShortExtension
      Control0..*
      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 Account.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 16. Account.extension:billingStatus
        Slice NamebillingStatus
        Definition

        R5: Account.billingStatus (new:CodeableConcept)

        ShortR5: Tracks the lifecycle of the account through the billing process (new)
        Comments

        Element Account.billingStatus has a context of Account based on following the parent source element upwards and mapping to Account. Element Account.billingStatus has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(R5: Tracks the lifecycle of the account through the billing process (new)) (Extension Type: CodeableConcept)
        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())
        18. Account.extension:diagnosis
        Slice Namediagnosis
        Definition

        R5: Account.diagnosis (new:BackboneElement)

        ShortR5: The list of diagnoses relevant to this account (new)
        Comments

        Element Account.diagnosis has a context of Account based on following the parent source element upwards and mapping to Account. Element Account.diagnosis 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
        TypeExtension(R5: The list of diagnoses relevant to this account (new)) (Complex Extension)
        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())
        20. Account.extension:procedure
        Slice Nameprocedure
        Definition

        R5: Account.procedure (new:BackboneElement)

        ShortR5: The list of procedures relevant to this account (new)
        Comments

        Element Account.procedure has a context of Account based on following the parent source element upwards and mapping to Account. Element Account.procedure 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
        TypeExtension(R5: The list of procedures relevant to this account (new)) (Complex Extension)
        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())
        22. Account.extension:relatedAccount
        Slice NamerelatedAccount
        Definition

        R5: Account.relatedAccount (new:BackboneElement)

        ShortR5: Other associated accounts related to this account (new)
        Comments

        Element Account.relatedAccount has a context of Account based on following the parent source element upwards and mapping to Account. Element Account.relatedAccount 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
        TypeExtension(R5: Other associated accounts related to this account (new)) (Complex Extension)
        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())
        24. Account.extension:currency
        Slice Namecurrency
        Definition

        R5: Account.currency (new:CodeableConcept)

        ShortR5: The base or default currency (new)
        Comments

        Element Account.currency has a context of Account based on following the parent source element upwards and mapping to Account. Element Account.currency has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(R5: The base or default currency (new)) (Extension Type: CodeableConcept)
        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())
        26. Account.extension:balance
        Slice Namebalance
        Definition

        R5: Account.balance (new:BackboneElement)

        ShortR5: Calculated account balance(s) (new)
        Comments

        Element Account.balance has a context of Account based on following the parent source element upwards and mapping to Account. Element Account.balance 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
        TypeExtension(R5: Calculated account balance(s) (new)) (Complex Extension)
        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())
        28. Account.extension:calculatedAt
        Slice NamecalculatedAt
        Definition

        R5: Account.calculatedAt (new:instant)

        ShortR5: Time the balance amount was calculated (new)
        Comments

        Element Account.calculatedAt has a context of Account based on following the parent source element upwards and mapping to Account. Element Account.calculatedAt has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). The total(s) are not typically updated using the restful API but more often by back-end processes included in a typical finance system.

        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(R5: Time the balance amount was calculated (new)) (Extension Type: instant)
        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())
        30. Account.modifierExtension
        Definition

        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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
        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 resource that contains them
        Summaryfalse
        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
        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())
        32. Account.identifier
        Definition

        Unique identifier used to reference the account. Might or might not be intended for human use (e.g. credit card number).

        ShortAccount number
        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control0..*
        TypeIdentifier
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        34. Account.status
        Definition

        Indicates whether the account is presently used/usable or not.

        Shortactive | inactive | entered-in-error | on-hold | unknown
        Comments

        This element is labeled as a modifier because the status contains the codes inactive and entered-in-error that mark the Account as not currently valid.

        Control1..1
        BindingThe codes SHALL be taken from AccountStatus
        (required to http://hl7.org/fhir/ValueSet/account-status|4.0.1)

        Indicates whether the account is available to be used.

        Typecode
        Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        36. Account.type
        Definition

        Categorizes the account for reporting and searching purposes.

        ShortE.g. patient, expense, depreciation
        Control0..1
        BindingFor example codes, see AccountTypes
        (example to http://hl7.org/fhir/ValueSet/account-type|4.0.1)

        The usage type of this account, permits categorization of accounts.

        TypeCodeableConcept
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        38. Account.name
        Definition

        Name used for the account when displaying it to humans in reports, etc.

        ShortHuman-readable label
        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Alternate NamesTitle
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        40. Account.subject
        Definition

        Identifies the entity which incurs the expenses. While the immediate recipients of services or goods might be entities related to the subject, the expenses were ultimately incurred by the subject of the Account.

        ShortThe entity that caused the expenses
        Comments

        Accounts can be applied to non-patients for tracking other non-patient related activities, such as group services (patients not tracked, and costs charged to another body), or might not be allocated.

        Control0..*
        TypeReference(Patient, Device, Practitioner, PractitionerRole, Location, HealthcareService, Organization)
        Is Modifierfalse
        Summarytrue
        Alternate Namestarget
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        42. Account.servicePeriod
        Definition

        The date range of services associated with this account.

        ShortTransaction window
        Comments

        It is possible for transactions to be posted outside the service period, as long as the service was provided within the defined service period.

        Control0..1
        TypePeriod
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        44. Account.coverage
        Definition

        The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account.

        ShortThe party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account
        Comments

        Typically. this may be some form of insurance, internal charges, or self-pay.

        Local or jurisdictional business rules may determine which coverage covers which types of billable items charged to the account, and in which order. Where the order is important, a local/jurisdictional extension may be defined to specify the order for the type of charge.

        Control0..*
        TypeBackboneElement
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        46. Account.coverage.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
        48. Account.coverage.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())
        50. Account.coverage.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())
        52. Account.coverage.coverage
        Definition

        The party(s) that contribute to payment (or part of) of the charges applied to this account (including self-pay).

        A coverage may only be responsible for specific types of charges, and the sequence of the coverages in the account could be important when processing billing.

        ShortThe party(s), such as insurances, that may contribute to the payment of this account
        Control1..1
        TypeReference(Coverage)
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        54. Account.coverage.priority
        Definition

        The priority of the coverage in the context of this account.

        ShortThe priority of the coverage in the context of this account
        Comments

        It is common in some jurisdictions for there to be multiple coverages allocated to an account, and a sequence is required to order the settling of the account (often with insurance claiming).

        Control0..1
        TypepositiveInt
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Alternate Namescoordination of benefit priority
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        56. Account.owner
        Definition

        Indicates the service area, hospital, department, etc. with responsibility for managing the Account.

        ShortEntity managing the Account
        Control0..1
        TypeReference(Organization)
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        58. Account.description
        Definition

        Provides additional information about what the account tracks and how it is used.

        ShortExplanation of purpose/use
        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        60. Account.guarantor
        Definition

        The parties responsible for balancing the account if other payment options fall short.

        ShortThe parties ultimately responsible for balancing the Account
        Control0..*
        TypeBackboneElement
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        62. Account.guarantor.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
        64. Account.guarantor.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())
        66. Account.guarantor.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())
        68. Account.guarantor.party
        Definition

        The entity who is responsible.

        ShortResponsible entity
        Control1..1
        TypeReference(Patient, RelatedPerson, Organization)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        70. Account.guarantor.onHold
        Definition

        A guarantor may be placed on credit hold or otherwise have their role temporarily suspended.

        ShortCredit or other hold applied
        Control0..1
        Typeboolean
        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()))
        72. Account.guarantor.period
        Definition

        The timeframe during which the guarantor accepts responsibility for the account.

        ShortGuarantee account during
        Control0..1
        TypePeriod
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        74. Account.partOf
        Definition

        Reference to a parent Account.

        ShortReference to a parent Account
        Control0..1
        TypeReference(Account)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))