Moderne Patient:innenabrechnung und Datenkommunikation on FHIR (MOPED)
0.1.0 - ci-build
Moderne Patient:innenabrechnung und Datenkommunikation on FHIR (MOPED) - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Draft as of 2025-07-11 |
Definitions for the MopedARKStatusUpdate resource profile.
Guidance on how to interpret the contents of this table can be foundhere
0. PaymentReconciliation | |
Definition | This resource provides the details including amount of a payment and allocates the payment items being paid. |
Short | PaymentReconciliation resource |
Control | 0..* |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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. PaymentReconciliation.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. |
Short | A 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 its narrative along with other profiles, value sets, etc. |
Control | 0..1 |
Type | uri |
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
4. PaymentReconciliation.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
Short | Contained, 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. |
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
Type | Resource |
Is Modifier | false |
Must Support | false |
Summary | false |
Alternate Names | inline resources, anonymous resources, contained resources |
6. PaymentReconciliation.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 managable, 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. |
Short | ExtensionAdditional 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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Must Support | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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()) |
Slicing | This element introduces a set of slices on PaymentReconciliation.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
8. PaymentReconciliation.extension:Zahlungsprozentsatz | |
Slice Name | Zahlungsprozentsatz |
Definition | Prozentsatz der Zahlung |
Short | Prozentsatz der Zahlung |
Control | 0..1 |
Type | Extension(Prozentsatz der Zahlung) (Extension Type: decimal) |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | 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()) |
10. PaymentReconciliation.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 managable, 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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
Must Support | false |
Summary | true |
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 Names | extensions, user content |
Invariants | 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. PaymentReconciliation.type | |
Definition | Code to indicate the nature of the payment such as payment, adjustment. |
Short | Category of payment |
Control | 1..1 |
Binding | Unless not suitable, these codes SHALL be taken from PaymentTypeCodeshttp://hl7.org/fhir/ValueSet/payment-type (extensible to http://hl7.org/fhir/ValueSet/payment-type ) |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
14. PaymentReconciliation.status | |
Definition | The status of the resource instance. |
Short | active | cancelled | draft | entered-in-error |
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
Control | 1..1 |
Binding | The codes SHALL be taken from FinancialResourceStatusCodeshttp://hl7.org/fhir/ValueSet/fm-status|5.0.0 (required to http://hl7.org/fhir/ValueSet/fm-status|5.0.0 )A code specifying the state of the resource instance. |
Type | code |
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
16. PaymentReconciliation.created | |
Definition | The date when the resource was created. |
Short | Creation date |
Control | 1..1 |
Type | dateTime |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | Need to record a timestamp for use by both the recipient and the issuer. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
18. PaymentReconciliation.date | |
Definition | The date of payment as indicated on the financial instrument. |
Short | When payment issued |
Control | 1..1 |
Type | date |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | To advise the payee when payment can be expected. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
20. PaymentReconciliation.referenceNumber | |
Definition | The check number, eft reference, car processor reference. |
Short | ZahlungsidentifikationCheck number or payment reference |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
22. PaymentReconciliation.amount | |
Definition | Total payment amount as indicated on the financial instrument. |
Short | Total amount of Payment |
Control | 1..1 |
Type | Money |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | Needed to provide the actual payment amount. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
24. PaymentReconciliation.amount.currency | |
Definition | ISO 4217 Currency Code. |
Short | ISO 4217 Currency Code |
Control | 0..1 |
Binding | The codes SHALL be taken from Currencieshttp://hl7.org/fhir/ValueSet/currencies|5.0.0 (required to http://hl7.org/fhir/ValueSet/currencies|5.0.0 )A code indicating the currency, taken from ISO 4217. |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | A code indicating the currency, taken from ISO 4217. |
Pattern Value | EUR |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
26. PaymentReconciliation.allocation | |
Definition | Distribution of the payment amount for a previously acknowledged payable. |
Short | Settlement particulars |
Control | 10..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
Summary | false |
Requirements | Needed to show how the payment amount is distributed across the payables. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
28. PaymentReconciliation.allocation.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 managable, 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. |
Short | ExtensionAdditional 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. |
Control | 10..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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()) |
Slicing | This element introduces a set of slices on PaymentReconciliation.allocation.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
30. PaymentReconciliation.allocation.extension:KeineZahlungGrund | |
Slice Name | KeineZahlungGrund |
Definition | Grund warum keine Zahlung erfolgte |
Short | Grund warum keine Zahlung erfolgte |
Control | 0..1 |
Type | Extension(Grund warum keine Zahlung erfolgte) (Extension Type: string) |
Is Modifier | false |
Summary | false |
Invariants | 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()) |
32. PaymentReconciliation.allocation.extension:Zahlungskennzeichen | |
Slice Name | Zahlungskennzeichen |
Definition | MOPED Extension für die Kostenmeldung. Konstenmeldung für A = Ausländerverrechnung, R = Regressangelegenheiten oder K = Kosteninformation |
Short | Zahlungskennzeichen |
Control | 1..1 |
Type | Extension(Zahlungskennzeichen) (Extension Type: Coding) |
Is Modifier | false |
Summary | false |
Invariants | 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()) |
34. PaymentReconciliation.allocation.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 managable, 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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
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 Names | extensions, user content, modifiers |
Invariants | 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()) |
36. PaymentReconciliation.allocation.target | |
Definition | Specific resource to which the payment/adjustment/advance applies. |
Short | Subject of the payment |
Control | 10..1 |
Type | Reference(MOPED ARKRequest, Claim, Account, Invoice, ChargeItem, Encounter, Contract) |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
38. PaymentReconciliation.allocation.type | |
Definition | Code to indicate the nature of the payment. |
Short | Category of payment |
Comments | For example: payment, adjustment, funds advance, etc. |
Control | 0..1 |
Binding | The codes SHALL be taken from Unless not suitable, these codes SHALL be taken from Arten von Moped Payment Types VShttp://hl7.org/fhir/ValueSet/payment-type (required to https://elga.moped.at/ValueSet/MopedPaymentTypesVS ) |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Requirements | Needed to provide context for the amount. |
Invariants | 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. PaymentReconciliation | |
2. PaymentReconciliation.extension | |
Slicing | This element introduces a set of slices on PaymentReconciliation.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
4. PaymentReconciliation.extension:Zahlungsprozentsatz | |
Slice Name | Zahlungsprozentsatz |
Control | 0..1 |
Type | Extension(Prozentsatz der Zahlung) (Extension Type: decimal) |
6. PaymentReconciliation.referenceNumber | |
Short | Zahlungsidentifikation |
8. PaymentReconciliation.amount | |
10. PaymentReconciliation.amount.currency | |
Pattern Value | EUR |
12. PaymentReconciliation.allocation | |
Control | 1..? |
14. PaymentReconciliation.allocation.extension | |
Control | 1..? |
Slicing | This element introduces a set of slices on PaymentReconciliation.allocation.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
16. PaymentReconciliation.allocation.extension:KeineZahlungGrund | |
Slice Name | KeineZahlungGrund |
Control | 0..1 |
Type | Extension(Grund warum keine Zahlung erfolgte) (Extension Type: string) |
18. PaymentReconciliation.allocation.extension:Zahlungskennzeichen | |
Slice Name | Zahlungskennzeichen |
Control | 1..1 |
Type | Extension(Zahlungskennzeichen) (Extension Type: Coding) |
20. PaymentReconciliation.allocation.target | |
Control | 1..? |
Type | Reference(MOPED ARKRequest) |
22. PaymentReconciliation.allocation.type | |
Binding | The codes SHALL be taken from Arten von Moped Payment Types VS (required to https://elga.moped.at/ValueSet/MopedPaymentTypesVS ) |
Guidance on how to interpret the contents of this table can be foundhere
0. PaymentReconciliation | |
Definition | This resource provides the details including amount of a payment and allocates the payment items being paid. |
Short | PaymentReconciliation resource |
Control | 0..* |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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. PaymentReconciliation.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Short | Logical id of this artifact |
Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
Control | 0..1 |
Type | id |
Is Modifier | false |
Must Support | false |
Summary | true |
4. PaymentReconciliation.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. |
Short | Metadata about the resource |
Control | 0..1 |
Type | Meta |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
6. PaymentReconciliation.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. |
Short | A 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 its narrative along with other profiles, value sets, etc. |
Control | 0..1 |
Type | uri |
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
8. PaymentReconciliation.language | |
Definition | The base language in which the resource is written. |
Short | Language 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). |
Control | 0..1 |
Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0 )IETF language tag for a human language |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
10. PaymentReconciliation.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. |
Short | Text summary of the resource, for human interpretation |
Comments | Contained resources do not have a 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. |
Control | 0..1 This element is affected by the following invariants: dom-6 |
Type | Narrative |
Is Modifier | false |
Must Support | false |
Summary | false |
Alternate Names | narrative, html, xhtml, display |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
12. PaymentReconciliation.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
Short | Contained, 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. |
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
Type | Resource |
Is Modifier | false |
Must Support | false |
Summary | false |
Alternate Names | inline resources, anonymous resources, contained resources |
14. PaymentReconciliation.extension | |
Definition | An Extension |
Short | Extension |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | 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() ) |
Slicing | This element introduces a set of slices on PaymentReconciliation.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
16. PaymentReconciliation.extension:Zahlungsprozentsatz | |
Slice Name | Zahlungsprozentsatz |
Definition | Prozentsatz der Zahlung |
Short | Prozentsatz der Zahlung |
Control | 0..1 |
Type | Extension(Prozentsatz der Zahlung) (Extension Type: decimal) |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | 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() ) |
18. PaymentReconciliation.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 managable, 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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
Must Support | false |
Summary | true |
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 Names | extensions, user content |
Invariants | 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. PaymentReconciliation.identifier | |
Definition | A unique identifier assigned to this payment reconciliation. |
Short | Business Identifier for a payment reconciliation |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Is Modifier | false |
Must Support | false |
Summary | false |
Requirements | Allows payment reconciliations to be distinguished and referenced. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
22. PaymentReconciliation.type | |
Definition | Code to indicate the nature of the payment such as payment, adjustment. |
Short | Category of payment |
Control | 1..1 |
Binding | Unless not suitable, these codes SHALL be taken from PaymentTypeCodes (extensible to http://hl7.org/fhir/ValueSet/payment-type ) |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
24. PaymentReconciliation.status | |
Definition | The status of the resource instance. |
Short | active | cancelled | draft | entered-in-error |
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
Control | 1..1 |
Binding | The codes SHALL be taken from FinancialResourceStatusCodes (required to http://hl7.org/fhir/ValueSet/fm-status|5.0.0 )A code specifying the state of the resource instance. |
Type | code |
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
26. PaymentReconciliation.kind | |
Definition | The workflow or activity which gave rise to or during which the payment ocurred such as a kiosk, deposit on account, periodic payment etc. |
Short | Workflow originating payment |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from PaymentKind (extensible to http://hl7.org/fhir/ValueSet/payment-kind ) |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
28. PaymentReconciliation.period | |
Definition | The period of time for which payments have been gathered into this bulk payment for settlement. |
Short | Period covered |
Control | 0..1 |
Type | Period |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | Needed to allow receivers to monitor and reconcile payment issuer schedules. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
30. PaymentReconciliation.created | |
Definition | The date when the resource was created. |
Short | Creation date |
Control | 1..1 |
Type | dateTime |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | Need to record a timestamp for use by both the recipient and the issuer. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
32. PaymentReconciliation.enterer | |
Definition | Payment enterer if not the actual payment issuer. |
Short | Who entered the payment |
Control | 0..1 |
Type | Reference(Practitioner, PractitionerRole, Organization) |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
34. PaymentReconciliation.issuerType | |
Definition | The type of the source such as patient or insurance. |
Short | Nature of the source |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from PaymentIssuerType (extensible to http://hl7.org/fhir/ValueSet/payment-issuertype ) |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Requirements | Providers may need to identify the source to know to which sub-ledger to apply the payment. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
36. PaymentReconciliation.paymentIssuer | |
Definition | The party who generated the payment. |
Short | Party generating payment |
Comments | This party is also responsible for the reconciliation. |
Control | 0..1 |
Type | Reference(Organization, Patient, RelatedPerson) |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | Need to identify the party resonsible for the payment and this resource. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
38. PaymentReconciliation.request | |
Definition | Original request resource reference. |
Short | Reference to requesting resource |
Control | 0..1 |
Type | Reference(Task) |
Is Modifier | false |
Must Support | false |
Summary | false |
Requirements | Needed to allow the response to be linked to the request. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
40. PaymentReconciliation.requestor | |
Definition | The practitioner who is responsible for the services rendered to the patient. |
Short | Responsible practitioner |
Control | 0..1 |
Type | Reference(Practitioner, PractitionerRole, Organization) |
Is Modifier | false |
Must Support | false |
Summary | false |
Requirements | Need to identify the party responsible for the request. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
42. PaymentReconciliation.outcome | |
Definition | The outcome of a request for a reconciliation. |
Short | queued | complete | error | partial |
Comments | The resource may be used to indicate that: the request has been held (queued) for processing; that it has been processed and errors found (error); that no errors were found and that some of the adjudication has been undertaken (partial) or that all of the adjudication has been undertaken (complete). |
Control | 0..1 |
Binding | The codes SHALL be taken from PaymentOutcome (required to http://hl7.org/fhir/ValueSet/payment-outcome|5.0.0 )The outcome of the processing. |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Requirements | To advise the requestor of an overall processing outcome. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
44. PaymentReconciliation.disposition | |
Definition | A human readable description of the status of the request for the reconciliation. |
Short | Disposition message |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Requirements | Provided for user display. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
46. PaymentReconciliation.date | |
Definition | The date of payment as indicated on the financial instrument. |
Short | When payment issued |
Control | 1..1 |
Type | date |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | To advise the payee when payment can be expected. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
48. PaymentReconciliation.location | |
Definition | The location of the site or device for electronic transfers or physical location for cash payments. |
Short | Where payment collected |
Control | 0..1 |
Type | Reference(Location) |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
50. PaymentReconciliation.method | |
Definition | The means of payment such as check, card cash, or electronic funds transfer. |
Short | Payment instrument |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from hl7VS-paymentMethodCode (extensible to http://terminology.hl7.org/ValueSet/v2-0570 ) |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
52. PaymentReconciliation.cardBrand | |
Definition | The card brand such as debit, Visa, Amex etc. used if a card is the method of payment. |
Short | Type of card |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
54. PaymentReconciliation.accountNumber | |
Definition | A portion of the account number, often the last 4 digits, used for verification not charging purposes. |
Short | Digits for verification |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
56. PaymentReconciliation.expirationDate | |
Definition | The year and month (YYYY-MM) when the instrument, typically card, expires. |
Short | Expiration year-month |
Control | 0..1 |
Type | date |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
58. PaymentReconciliation.processor | |
Definition | The name of the card processor, etf processor, bank for checks. |
Short | Processor name |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
60. PaymentReconciliation.referenceNumber | |
Definition | The check number, eft reference, car processor reference. |
Short | Zahlungsidentifikation |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
62. PaymentReconciliation.authorization | |
Definition | An alphanumeric issued by the processor to confirm the successful issuance of payment. |
Short | Authorization number |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
64. PaymentReconciliation.tenderedAmount | |
Definition | The amount offered by the issuer, typically applies to cash when the issuer provides an amount in bank note denominations equal to or excess of the amount actually being paid. |
Short | Amount offered by the issuer |
Control | 0..1 |
Type | Money |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
66. PaymentReconciliation.returnedAmount | |
Definition | The amount returned by the receiver which is excess to the amount payable, often referred to as 'change'. |
Short | Amount returned by the receiver |
Control | 0..1 |
Type | Money |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
68. PaymentReconciliation.amount | |
Definition | Total payment amount as indicated on the financial instrument. |
Short | Total amount of Payment |
Control | 1..1 |
Type | Money |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | Needed to provide the actual payment amount. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
70. PaymentReconciliation.amount.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
72. PaymentReconciliation.amount.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 managable, 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. |
Short | Additional 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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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() ) |
Slicing | This element introduces a set of slices on PaymentReconciliation.amount.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
74. PaymentReconciliation.amount.value | |
Definition | Numerical value (with implicit precision). |
Short | Numerical value (with implicit precision) |
Comments | Monetary values have their own rules for handling precision (refer to standard accounting text books). |
Control | 0..1 |
Type | decimal |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | The amount of the currency. The value includes an implicit precision in the presentation of the value. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
76. PaymentReconciliation.amount.currency | |
Definition | ISO 4217 Currency Code. |
Short | ISO 4217 Currency Code |
Control | 0..1 |
Binding | The codes SHALL be taken from Currencies (required to http://hl7.org/fhir/ValueSet/currencies|5.0.0 )A code indicating the currency, taken from ISO 4217. |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | A code indicating the currency, taken from ISO 4217. |
Pattern Value | EUR |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
78. PaymentReconciliation.paymentIdentifier | |
Definition | Issuer's unique identifier for the payment instrument. |
Short | Business identifier for the payment |
Comments | For example: EFT number or check number. |
Control | 0..1 |
Type | Identifier |
Is Modifier | false |
Must Support | false |
Summary | false |
Requirements | Enable the receiver to reconcile when payment is received. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
80. PaymentReconciliation.allocation | |
Definition | Distribution of the payment amount for a previously acknowledged payable. |
Short | Settlement particulars |
Control | 1..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
Summary | false |
Requirements | Needed to show how the payment amount is distributed across the payables. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
82. PaymentReconciliation.allocation.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
84. PaymentReconciliation.allocation.extension | |
Definition | An Extension |
Short | Extension |
Control | 1..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Invariants | 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() ) |
Slicing | This element introduces a set of slices on PaymentReconciliation.allocation.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
86. PaymentReconciliation.allocation.extension:KeineZahlungGrund | |
Slice Name | KeineZahlungGrund |
Definition | Grund warum keine Zahlung erfolgte |
Short | Grund warum keine Zahlung erfolgte |
Control | 0..1 |
Type | Extension(Grund warum keine Zahlung erfolgte) (Extension Type: string) |
Is Modifier | false |
Summary | false |
Invariants | 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() ) |
88. PaymentReconciliation.allocation.extension:Zahlungskennzeichen | |
Slice Name | Zahlungskennzeichen |
Definition | MOPED Extension für die Kostenmeldung. Konstenmeldung für A = Ausländerverrechnung, R = Regressangelegenheiten oder K = Kosteninformation |
Short | Zahlungskennzeichen |
Control | 1..1 |
Type | Extension(Zahlungskennzeichen) (Extension Type: Coding) |
Is Modifier | false |
Summary | false |
Invariants | 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() ) |
90. PaymentReconciliation.allocation.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 managable, 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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
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 Names | extensions, user content, modifiers |
Invariants | 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() ) |
92. PaymentReconciliation.allocation.identifier | |
Definition | Unique identifier for the current payment item for the referenced payable. |
Short | Business identifier of the payment detail |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
Is Modifier | false |
Must Support | false |
Summary | false |
Requirements | Needed for reconciliation of payments. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
94. PaymentReconciliation.allocation.predecessor | |
Definition | Unique identifier for the prior payment item for the referenced payable. |
Short | Business identifier of the prior payment detail |
Control | 0..1 |
Type | Identifier |
Is Modifier | false |
Must Support | false |
Summary | false |
Requirements | Needed for reconciliation of payments. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
96. PaymentReconciliation.allocation.target | |
Definition | Specific resource to which the payment/adjustment/advance applies. |
Short | Subject of the payment |
Control | 1..1 |
Type | Reference(MOPED ARKRequest) |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
98. PaymentReconciliation.allocation.targetItem[x] | |
Definition | Identifies the claim line item, encounter or other sub-element being paid. Note payment may be partial, that is not match the then outstanding balance or amount incurred. |
Short | Sub-element of the subject |
Control | 0..1 |
Type | Choice of: string, Identifier, positiveInt |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
100. PaymentReconciliation.allocation.encounter | |
Definition | The Encounter to which this payment applies, may be completed by the receiver, used for search. |
Short | Applied-to encounter |
Control | 0..1 |
Type | Reference(Encounter) |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
102. PaymentReconciliation.allocation.account | |
Definition | The Account to which this payment applies, may be completed by the receiver, used for search. |
Short | Applied-to account |
Control | 0..1 |
Type | Reference(Account) |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
104. PaymentReconciliation.allocation.type | |
Definition | Code to indicate the nature of the payment. |
Short | Category of payment |
Comments | For example: payment, adjustment, funds advance, etc. |
Control | 0..1 |
Binding | The codes SHALL be taken from Arten von Moped Payment Types VS (required to https://elga.moped.at/ValueSet/MopedPaymentTypesVS ) |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Requirements | Needed to provide context for the amount. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
106. PaymentReconciliation.allocation.submitter | |
Definition | The party which submitted the claim or financial transaction. |
Short | Submitter of the request |
Control | 0..1 |
Type | Reference(Practitioner, PractitionerRole, Organization) |
Is Modifier | false |
Must Support | false |
Summary | false |
Requirements | Needed for audit and validation. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
108. PaymentReconciliation.allocation.response | |
Definition | A resource, such as a ClaimResponse, which contains a commitment to payment. |
Short | Response committing to a payment |
Control | 0..1 |
Type | Reference(ClaimResponse) |
Is Modifier | false |
Must Support | false |
Summary | false |
Requirements | Needed to provide a linkage to the payment commitment. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
110. PaymentReconciliation.allocation.date | |
Definition | The date from the response resource containing a commitment to pay. |
Short | Date of commitment to pay |
Control | 0..1 |
Type | date |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Requirements | Needed for audit and validation. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
112. PaymentReconciliation.allocation.responsible | |
Definition | A reference to the individual who is responsible for inquiries regarding the response and its payment. |
Short | Contact for the response |
Control | 0..1 |
Type | Reference(PractitionerRole) |
Is Modifier | false |
Must Support | false |
Summary | false |
Requirements | To provide contact information. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
114. PaymentReconciliation.allocation.payee | |
Definition | The party which is receiving the payment. |
Short | Recipient of the payment |
Control | 0..1 |
Type | Reference(Practitioner, PractitionerRole, Organization) |
Is Modifier | false |
Must Support | false |
Summary | false |
Requirements | Needed for audit and validation. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
116. PaymentReconciliation.allocation.amount | |
Definition | The monetary amount allocated from the total payment to the payable. |
Short | Amount allocated to this payable |
Control | 0..1 |
Type | Money |
Is Modifier | false |
Must Support | false |
Summary | false |
Requirements | Needed to explain the distribution of the payment to the payables. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
118. PaymentReconciliation.formCode | |
Definition | A code for the form to be used for printing the content. |
Short | Printed form identifier |
Comments | May be needed to identify specific jurisdictional forms. |
Control | 0..1 |
Binding | For example codes, see FormCodes (example to http://hl7.org/fhir/ValueSet/forms )The forms codes. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Requirements | Needed to specify the specific form used for producing output for this response. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
120. PaymentReconciliation.processNote | |
Definition | A note that describes or explains the processing in a human readable form. |
Short | Note concerning processing |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
Summary | false |
Requirements | Provides the specific textual explanations associated with the processing. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
122. PaymentReconciliation.processNote.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
124. PaymentReconciliation.processNote.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 managable, 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. |
Short | Additional 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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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() ) |
126. PaymentReconciliation.processNote.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 managable, 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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
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 Names | extensions, user content, modifiers |
Invariants | 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() ) |
128. PaymentReconciliation.processNote.type | |
Definition | The business purpose of the note text. |
Short | display | print | printoper |
Control | 0..1 |
Binding | The codes SHALL be taken from NoteType (required to http://hl7.org/fhir/ValueSet/note-type|5.0.0 )The presentation types of notes. |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Requirements | To convey the expectation for when the text is used. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
130. PaymentReconciliation.processNote.text | |
Definition | The explanation or description associated with the processing. |
Short | Note explanatory text |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Requirements | Required to provide human readable explanation. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |