HL7® FHIR® Malaysia Core (MY Core) Implementation Guide
2.0.1 - ci-build

HL7® FHIR® Malaysia Core (MY Core) Implementation Guide - Local Development build (v2.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: PaymentReconciliation (MY Core)

Official URL: http://fhir.hie.moh.gov.my/StructureDefinition/PaymentReconciliation-my-core Version: 2.0.1
Active as of 2024-03-13 Computable Name: PaymentReconciliationMyCore

This resource provides the details including amount of a payment and allocates the payment items being paid.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentReconciliation 0..* PaymentReconciliation PaymentReconciliation resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:type 0..* (Complex) Extension about the type of PaymentReconciliation
URL: http://fhir.hie.moh.gov.my/StructureDefinition/pr-print-my-core
.... extension:print 0..* CodeableConcept Extension to define whether this PaymentReconciliation has been printed at least once or not
URL: http://fhir.hie.moh.gov.my/StructureDefinition/pr-type-my-core
Binding: ValueSetBillingType (MY Core) (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:receiptNo 0..* Identifier Business Identifier for a payment reconciliation
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.hie.moh.gov.my/sid/receipt-no
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... identifier:ptjNo 0..* Identifier Business Identifier for a payment reconciliation
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.hie.moh.gov.my/sid/ptj-no
..... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!Σ 1..1 code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
... created Σ 1..1 dateTime Creation date
... paymentDate Σ 1..1 date When payment issued
... paymentAmount Σ 1..1 Money Total amount of Payment

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PaymentReconciliation.identifier:receiptNo.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
PaymentReconciliation.identifier:ptjNo.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
PaymentReconciliation.statusrequiredFinancialResourceStatusCodes
http://hl7.org/fhir/ValueSet/fm-status|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPaymentReconciliationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPaymentReconciliationIf 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-4errorPaymentReconciliationIf 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-5errorPaymentReconciliationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePaymentReconciliationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from PaymentReconciliation

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentReconciliation 0..* PaymentReconciliation PaymentReconciliation resource
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:type 0..* (Complex) Extension about the type of PaymentReconciliation
URL: http://fhir.hie.moh.gov.my/StructureDefinition/pr-print-my-core
.... extension:print 0..* CodeableConcept Extension to define whether this PaymentReconciliation has been printed at least once or not
URL: http://fhir.hie.moh.gov.my/StructureDefinition/pr-type-my-core
Binding: ValueSetBillingType (MY Core) (required)
... Slices for identifier 0..* Identifier Business Identifier for a payment reconciliation
Slice: Unordered, Open by value:system
.... identifier:receiptNo 0..* Identifier Business Identifier for a payment reconciliation
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.hie.moh.gov.my/sid/receipt-no
..... value 1..1 string The value that is unique
.... identifier:ptjNo 0..* Identifier Business Identifier for a payment reconciliation
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.hie.moh.gov.my/sid/ptj-no
..... value 1..1 string The value that is unique
... paymentIdentifier
.... system 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.hie.moh.gov.my/sid/payment-transaction-no
.... value 1..1 string The value that is unique
.... identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.hie.moh.gov.my/sid/bank-code
..... value 1..1 string The value that is unique
.... type 1..1 CodeableConcept Category of payment
Binding: ValueSetPaymentType (MY Core) (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
PaymentReconciliation.detail.typerequiredValueSetPaymentTypeMyCore(a valid code from CodeSystemPaymentType (MY Core))
http://fhir.hie.moh.gov.my/ValueSet/payment-type-my-core
From this IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentReconciliation 0..* PaymentReconciliation PaymentReconciliation resource
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:type 0..* (Complex) Extension about the type of PaymentReconciliation
URL: http://fhir.hie.moh.gov.my/StructureDefinition/pr-print-my-core
.... extension:print 0..* CodeableConcept Extension to define whether this PaymentReconciliation has been printed at least once or not
URL: http://fhir.hie.moh.gov.my/StructureDefinition/pr-type-my-core
Binding: ValueSetBillingType (MY Core) (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier 0..* Identifier Business Identifier for a payment reconciliation
Slice: Unordered, Open by value:system
.... identifier:receiptNo 0..* Identifier Business Identifier for a payment reconciliation
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.hie.moh.gov.my/sid/receipt-no
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:ptjNo 0..* Identifier Business Identifier for a payment reconciliation
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.hie.moh.gov.my/sid/ptj-no
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
... period Σ 0..1 Period Period covered
... created Σ 1..1 dateTime Creation date
... paymentIssuer Σ 0..1 Reference(Organization) Party generating payment
... request 0..1 Reference(Task) Reference to requesting resource
... requestor 0..1 Reference(Practitioner | PractitionerRole | Organization) Responsible practitioner
... outcome 0..1 code queued | complete | error | partial
Binding: ClaimProcessingCodes (required): The outcome of the processing.
... disposition 0..1 string Disposition message
... paymentDate Σ 1..1 date When payment issued
... paymentAmount Σ 1..1 Money Total amount of Payment
... paymentIdentifier 0..1 Identifier Business identifier for the payment
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.hie.moh.gov.my/sid/payment-transaction-no
.... value Σ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... detail 0..* BackboneElement Settlement particulars
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier 0..1 Identifier Business identifier of the payment detail
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.hie.moh.gov.my/sid/bank-code
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... predecessor 0..1 Identifier Business identifier of the prior payment detail
.... type 1..1 CodeableConcept Category of payment
Binding: ValueSetPaymentType (MY Core) (required)
.... request 0..1 Reference(Resource) Request giving rise to the payment
.... submitter 0..1 Reference(Practitioner | PractitionerRole | Organization) Submitter of the request
.... response 0..1 Reference(Resource) Response committing to a payment
.... date 0..1 date Date of commitment to pay
.... responsible 0..1 Reference(PractitionerRole) Contact for the response
.... payee 0..1 Reference(Practitioner | PractitionerRole | Organization) Recipient of the payment
.... amount 0..1 Money Amount allocated to this payable
... formCode 0..1 CodeableConcept Printed form identifier
Binding: Form Codes (example): The forms codes.
... processNote 0..* BackboneElement Note concerning processing
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..1 code display | print | printoper
Binding: NoteType (required): The presentation types of notes.
.... text 0..1 string Note explanatory text

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PaymentReconciliation.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
PaymentReconciliation.identifier:receiptNo.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
PaymentReconciliation.identifier:receiptNo.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
PaymentReconciliation.identifier:ptjNo.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
PaymentReconciliation.identifier:ptjNo.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
PaymentReconciliation.statusrequiredFinancialResourceStatusCodes
http://hl7.org/fhir/ValueSet/fm-status|4.0.1
From the FHIR Standard
PaymentReconciliation.outcomerequiredClaimProcessingCodes
http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1
From the FHIR Standard
PaymentReconciliation.paymentIdentifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
PaymentReconciliation.paymentIdentifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
PaymentReconciliation.detail.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
PaymentReconciliation.detail.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
PaymentReconciliation.detail.typerequiredValueSetPaymentTypeMyCore(a valid code from CodeSystemPaymentType (MY Core))
http://fhir.hie.moh.gov.my/ValueSet/payment-type-my-core
From this IG
PaymentReconciliation.formCodeexampleForm Codes
http://hl7.org/fhir/ValueSet/forms
From the FHIR Standard
PaymentReconciliation.processNote.typerequiredNoteType
http://hl7.org/fhir/ValueSet/note-type|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPaymentReconciliationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPaymentReconciliationIf 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-4errorPaymentReconciliationIf 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-5errorPaymentReconciliationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePaymentReconciliationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from PaymentReconciliation

Summary

Mandatory: 0 element(8 nested mandatory elements)
Fixed: 4 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of PaymentReconciliation.identifier

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentReconciliation 0..* PaymentReconciliation PaymentReconciliation resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:type 0..* (Complex) Extension about the type of PaymentReconciliation
URL: http://fhir.hie.moh.gov.my/StructureDefinition/pr-print-my-core
.... extension:print 0..* CodeableConcept Extension to define whether this PaymentReconciliation has been printed at least once or not
URL: http://fhir.hie.moh.gov.my/StructureDefinition/pr-type-my-core
Binding: ValueSetBillingType (MY Core) (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:receiptNo 0..* Identifier Business Identifier for a payment reconciliation
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.hie.moh.gov.my/sid/receipt-no
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... identifier:ptjNo 0..* Identifier Business Identifier for a payment reconciliation
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.hie.moh.gov.my/sid/ptj-no
..... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!Σ 1..1 code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
... created Σ 1..1 dateTime Creation date
... paymentDate Σ 1..1 date When payment issued
... paymentAmount Σ 1..1 Money Total amount of Payment

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PaymentReconciliation.identifier:receiptNo.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
PaymentReconciliation.identifier:ptjNo.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
PaymentReconciliation.statusrequiredFinancialResourceStatusCodes
http://hl7.org/fhir/ValueSet/fm-status|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPaymentReconciliationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPaymentReconciliationIf 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-4errorPaymentReconciliationIf 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-5errorPaymentReconciliationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePaymentReconciliationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from PaymentReconciliation

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentReconciliation 0..* PaymentReconciliation PaymentReconciliation resource
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:type 0..* (Complex) Extension about the type of PaymentReconciliation
URL: http://fhir.hie.moh.gov.my/StructureDefinition/pr-print-my-core
.... extension:print 0..* CodeableConcept Extension to define whether this PaymentReconciliation has been printed at least once or not
URL: http://fhir.hie.moh.gov.my/StructureDefinition/pr-type-my-core
Binding: ValueSetBillingType (MY Core) (required)
... Slices for identifier 0..* Identifier Business Identifier for a payment reconciliation
Slice: Unordered, Open by value:system
.... identifier:receiptNo 0..* Identifier Business Identifier for a payment reconciliation
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.hie.moh.gov.my/sid/receipt-no
..... value 1..1 string The value that is unique
.... identifier:ptjNo 0..* Identifier Business Identifier for a payment reconciliation
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.hie.moh.gov.my/sid/ptj-no
..... value 1..1 string The value that is unique
... paymentIdentifier
.... system 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.hie.moh.gov.my/sid/payment-transaction-no
.... value 1..1 string The value that is unique
.... identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.hie.moh.gov.my/sid/bank-code
..... value 1..1 string The value that is unique
.... type 1..1 CodeableConcept Category of payment
Binding: ValueSetPaymentType (MY Core) (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
PaymentReconciliation.detail.typerequiredValueSetPaymentTypeMyCore(a valid code from CodeSystemPaymentType (MY Core))
http://fhir.hie.moh.gov.my/ValueSet/payment-type-my-core
From this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentReconciliation 0..* PaymentReconciliation PaymentReconciliation resource
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:type 0..* (Complex) Extension about the type of PaymentReconciliation
URL: http://fhir.hie.moh.gov.my/StructureDefinition/pr-print-my-core
.... extension:print 0..* CodeableConcept Extension to define whether this PaymentReconciliation has been printed at least once or not
URL: http://fhir.hie.moh.gov.my/StructureDefinition/pr-type-my-core
Binding: ValueSetBillingType (MY Core) (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier 0..* Identifier Business Identifier for a payment reconciliation
Slice: Unordered, Open by value:system
.... identifier:receiptNo 0..* Identifier Business Identifier for a payment reconciliation
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.hie.moh.gov.my/sid/receipt-no
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:ptjNo 0..* Identifier Business Identifier for a payment reconciliation
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.hie.moh.gov.my/sid/ptj-no
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
... period Σ 0..1 Period Period covered
... created Σ 1..1 dateTime Creation date
... paymentIssuer Σ 0..1 Reference(Organization) Party generating payment
... request 0..1 Reference(Task) Reference to requesting resource
... requestor 0..1 Reference(Practitioner | PractitionerRole | Organization) Responsible practitioner
... outcome 0..1 code queued | complete | error | partial
Binding: ClaimProcessingCodes (required): The outcome of the processing.
... disposition 0..1 string Disposition message
... paymentDate Σ 1..1 date When payment issued
... paymentAmount Σ 1..1 Money Total amount of Payment
... paymentIdentifier 0..1 Identifier Business identifier for the payment
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.hie.moh.gov.my/sid/payment-transaction-no
.... value Σ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... detail 0..* BackboneElement Settlement particulars
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier 0..1 Identifier Business identifier of the payment detail
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.hie.moh.gov.my/sid/bank-code
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... predecessor 0..1 Identifier Business identifier of the prior payment detail
.... type 1..1 CodeableConcept Category of payment
Binding: ValueSetPaymentType (MY Core) (required)
.... request 0..1 Reference(Resource) Request giving rise to the payment
.... submitter 0..1 Reference(Practitioner | PractitionerRole | Organization) Submitter of the request
.... response 0..1 Reference(Resource) Response committing to a payment
.... date 0..1 date Date of commitment to pay
.... responsible 0..1 Reference(PractitionerRole) Contact for the response
.... payee 0..1 Reference(Practitioner | PractitionerRole | Organization) Recipient of the payment
.... amount 0..1 Money Amount allocated to this payable
... formCode 0..1 CodeableConcept Printed form identifier
Binding: Form Codes (example): The forms codes.
... processNote 0..* BackboneElement Note concerning processing
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..1 code display | print | printoper
Binding: NoteType (required): The presentation types of notes.
.... text 0..1 string Note explanatory text

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PaymentReconciliation.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
PaymentReconciliation.identifier:receiptNo.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
PaymentReconciliation.identifier:receiptNo.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
PaymentReconciliation.identifier:ptjNo.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
PaymentReconciliation.identifier:ptjNo.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
PaymentReconciliation.statusrequiredFinancialResourceStatusCodes
http://hl7.org/fhir/ValueSet/fm-status|4.0.1
From the FHIR Standard
PaymentReconciliation.outcomerequiredClaimProcessingCodes
http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1
From the FHIR Standard
PaymentReconciliation.paymentIdentifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
PaymentReconciliation.paymentIdentifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
PaymentReconciliation.detail.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
PaymentReconciliation.detail.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
PaymentReconciliation.detail.typerequiredValueSetPaymentTypeMyCore(a valid code from CodeSystemPaymentType (MY Core))
http://fhir.hie.moh.gov.my/ValueSet/payment-type-my-core
From this IG
PaymentReconciliation.formCodeexampleForm Codes
http://hl7.org/fhir/ValueSet/forms
From the FHIR Standard
PaymentReconciliation.processNote.typerequiredNoteType
http://hl7.org/fhir/ValueSet/note-type|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPaymentReconciliationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPaymentReconciliationIf 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-4errorPaymentReconciliationIf 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-5errorPaymentReconciliationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePaymentReconciliationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from PaymentReconciliation

Summary

Mandatory: 0 element(8 nested mandatory elements)
Fixed: 4 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of PaymentReconciliation.identifier

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Mandatory Data Elements

This structure defines these elements as mandatory data fields:

Element Description
PaymentReconciliation.status Status of the PaymentReconciliation e.g. active, cancelled, draft .
PaymentReconciliation.created Date on which the PaymentReconciliation is created.
PaymentReconciliation.paymentDate Date on which the actual payment is made.
PaymentReconciliation.paymentAmount Amount of money that was paid.