openIMIS FHIR R4 Implementation Guide
1.0.0 - ci-build
openIMIS FHIR R4 Implementation Guide
1.0.0 - ci-build
openIMIS FHIR R4 Implementation Guide - Local Development build (v1.0.0). See the Directory of published versions
| Official URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/openimis-payment-notice | Version: 1.0.0 | |||
| Active as of 2022-05-31 | Responsible: openIMIS Initiative | Computable Name: OpenIMISPaymentNotice | ||
Submit payment notice.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from PaymentNotice
Summary
Mandatory: 3 elements (2 nested mandatory elements)
Prohibited: 3 elements
Structures
This structure refers to these other structures:
This structure is derived from PaymentNotice
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  PaymentNotice | 0..* | PaymentNotice | PaymentNotice request | |
  identifier | 0..1 | Identifier | Business Identifier for the payment noctice | |
 type | 1..1 | CodeableConcept | Description of identifier | |
 coding | ||||
  code | 0..1 | code | PaymentNotice UUID Required Pattern: UUID | |
| value | 1..1 | string | The value that is unique | |
  request | 0..1 | Reference(openIMIS Invoice | openIMIS Bill) | Request reference | |
| response | 0..0 | |||
| provider | 0..0 | |||
| payment | 1..1 | Reference(PaymentReconciliation) | Payment Reconciliation | |
| paymentDate | 1..1 | date | Payment or clearing date | |
| payee | 0..0 | |||
| recipient | 1..1 | Reference(openIMIS Insurance Organization) | Party being notified | |
| amount | ||||
| value | 1..1 | decimal | Numerical value (with implicit precision) | |
| paymentStatus | 1..1 | CodeableConcept | Issued or cleared Status of the payment | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| PaymentNotice | 0..* | PaymentNotice | PaymentNotice request | |||||
 id | Σ | 0..1 | string | 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 | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | 0..1 | Identifier | Business Identifier for the payment noctice | |||||
| 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 | Σ | 1..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. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | PaymentNotice UUID Required Pattern: UUID | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| 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. | ||||
| request | 0..1 | Reference(openIMIS Invoice | openIMIS Bill) | Request reference | |||||
| created | Σ | 1..1 | dateTime | Creation date | ||||
| payment | Σ | 1..1 | Reference(PaymentReconciliation) | Payment Reconciliation | ||||
| paymentDate | 1..1 | date | Payment or clearing date | |||||
| recipient | Σ | 1..1 | Reference(openIMIS Insurance Organization) | Party being notified | ||||
| amount | Σ | 1..1 | Money | Monetary amount of 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 | |||||
| value | Σ | 1..1 | decimal | Numerical value (with implicit precision) | ||||
| currency | Σ | 0..1 | code | ISO 4217 Currency Code Binding: Currencies (required): A code indicating the currency, taken from ISO 4217. | ||||
| paymentStatus | 1..1 | CodeableConcept | Issued or cleared Status of the payment Binding: PaymentStatusCodes (example): The payment conveyance status codes. | |||||
| Documentation for this format | ||||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PaymentNotice | 0..* | PaymentNotice | PaymentNotice request | |
| Documentation for this format | ||||
This structure is derived from PaymentNotice
Summary
Mandatory: 3 elements (2 nested mandatory elements)
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from PaymentNotice
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PaymentNotice | 0..* | PaymentNotice | PaymentNotice request | |
| identifier | 0..1 | Identifier | Business Identifier for the payment noctice | |
| type | 1..1 | CodeableConcept | Description of identifier | |
| coding | ||||
| code | 0..1 | code | PaymentNotice UUID Required Pattern: UUID | |
| value | 1..1 | string | The value that is unique | |
| request | 0..1 | Reference(openIMIS Invoice | openIMIS Bill) | Request reference | |
| response | 0..0 | |||
| provider | 0..0 | |||
| payment | 1..1 | Reference(PaymentReconciliation) | Payment Reconciliation | |
| paymentDate | 1..1 | date | Payment or clearing date | |
| payee | 0..0 | |||
| recipient | 1..1 | Reference(openIMIS Insurance Organization) | Party being notified | |
| amount | ||||
| value | 1..1 | decimal | Numerical value (with implicit precision) | |
| paymentStatus | 1..1 | CodeableConcept | Issued or cleared Status of the payment | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| PaymentNotice | 0..* | PaymentNotice | PaymentNotice request | |||||
| id | Σ | 0..1 | string | 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 | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | 0..1 | Identifier | Business Identifier for the payment noctice | |||||
| 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 | Σ | 1..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. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | PaymentNotice UUID Required Pattern: UUID | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| 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. | ||||
| request | 0..1 | Reference(openIMIS Invoice | openIMIS Bill) | Request reference | |||||
| created | Σ | 1..1 | dateTime | Creation date | ||||
| payment | Σ | 1..1 | Reference(PaymentReconciliation) | Payment Reconciliation | ||||
| paymentDate | 1..1 | date | Payment or clearing date | |||||
| recipient | Σ | 1..1 | Reference(openIMIS Insurance Organization) | Party being notified | ||||
| amount | Σ | 1..1 | Money | Monetary amount of 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 | |||||
| value | Σ | 1..1 | decimal | Numerical value (with implicit precision) | ||||
| currency | Σ | 0..1 | code | ISO 4217 Currency Code Binding: Currencies (required): A code indicating the currency, taken from ISO 4217. | ||||
| paymentStatus | 1..1 | CodeableConcept | Issued or cleared Status of the payment Binding: PaymentStatusCodes (example): The payment conveyance status codes. | |||||
| Documentation for this format | ||||||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| PaymentNotice.language | preferred | CommonLanguages Max Binding: AllLanguages |
| PaymentNotice.identifier.use | required | IdentifierUse |
| PaymentNotice.identifier.type | extensible | Identifier Type Codes |
| PaymentNotice.status | required | FinancialResourceStatusCodes |
| PaymentNotice.amount.currency | required | Currencies |
| PaymentNotice.paymentStatus | example | PaymentStatusCodes |
| Id | Grade | Path | Details | Requirements |
| dom-2 | error | PaymentNotice | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | PaymentNotice | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | PaymentNotice | 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 | error | PaymentNotice | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Best Practice | PaymentNotice | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | PaymentNotice.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | PaymentNotice.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | PaymentNotice.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | PaymentNotice.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | PaymentNotice.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | PaymentNotice.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | PaymentNotice.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.identifier.type.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | PaymentNotice.identifier.type.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | PaymentNotice.identifier.type.coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.identifier.type.coding.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | PaymentNotice.identifier.type.coding.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | PaymentNotice.identifier.type.coding.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.identifier.type.coding.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.identifier.type.coding.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.identifier.type.coding.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.identifier.type.coding.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.identifier.type.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.request | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.created | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.payment | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.paymentDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.recipient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.amount | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.amount.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | PaymentNotice.amount.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | PaymentNotice.amount.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.amount.currency | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | PaymentNotice.paymentStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |