Connectathon 11 Snapshot

This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

7.9 Resource PaymentNotice - Content

Financial Management

Work Group

Maturity Level: 0

Compartments: Not linked to any defined compartments

This resource provides the status of the payment for goods and services rendered, and the request and response resource references.

7.9.1 Scope and Usage

The PaymentNotice resource indicates the resource for which the payment has been indicated and reports the current status information of that payment. The payment notice may be used by Payor to advise the Provider or Regulatory bodies of the state of a payment (cheque in the mail/EFT sent, payment cashed, payment cancelled), Employers or Exchanges may use this to advise Payors of premium payment.

Payors have the need to advise Providers and/or regulators, in jurisdictions where these are supported, of the status of Claim settlement and payment completion. This same resource may be used by employers and insurance exchanges to advise Payors that premium payments have been issued and settled.

Todo

Structure

Name	Flags	Card.	Type	Description & Constraints
PaymentNotice	Σ		DomainResource	PaymentNotice request
identifier	Σ	0..*	Identifier	Business Identifier
ruleset	Σ	0..1	Coding	Resource version Ruleset Codes (Example)
originalRuleset	Σ	0..1	Coding	Original version Ruleset Codes (Example)
created	Σ	0..1	dateTime	Creation date
target	Σ	0..1	Reference(Organization)	Insurer or Regulatory body
provider	Σ	0..1	Reference(Practitioner)	Responsible practitioner
organization	Σ	0..1	Reference(Organization)	Responsible organization
request	Σ	0..1	Reference(Any)	Request reference
response	Σ	0..1	Reference(Any)	Response reference
paymentStatus	Σ	1..1	Coding	Status of the payment Payment Status Codes (Example)
statusDate	Σ	0..1	date	Payment or clearing date
Documentation for this format

UML Diagram

XML Template

<PaymentNotice xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business Identifier --></identifier>
 <ruleset><!-- 0..1 Coding Resource version --></ruleset>
 <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset>
 <created value="[dateTime]"/><!-- 0..1 Creation date -->
 <target><!-- 0..1 Reference(Organization) Insurer or Regulatory body --></target>
 <provider><!-- 0..1 Reference(Practitioner) Responsible practitioner --></provider>
 <organization><!-- 0..1 Reference(Organization) Responsible organization --></organization>
 <request><!-- 0..1 Reference(Any) Request reference --></request>
 <response><!-- 0..1 Reference(Any) Response reference --></response>
 <paymentStatus><!-- 1..1 Coding Status of the payment --></paymentStatus>
 <statusDate value="[date]"/><!-- 0..1 Payment or clearing date -->
</PaymentNotice>

JSON Template

{
  "resourceType" : "PaymentNotice",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifier
  "ruleset" : { Coding }, // Resource version
  "originalRuleset" : { Coding }, // Original version
  "created" : "<dateTime>", // Creation date
  "target" : { Reference(Organization) }, // Insurer or Regulatory body
  "provider" : { Reference(Practitioner) }, // Responsible practitioner
  "organization" : { Reference(Organization) }, // Responsible organization
  "request" : { Reference(Any) }, // Request reference
  "response" : { Reference(Any) }, // Response reference
  "paymentStatus" : { Coding }, // R!  Status of the payment
  "statusDate" : "<date>" // Payment or clearing date
}

Structure

Name	Flags	Card.	Type	Description & Constraints
PaymentNotice	Σ		DomainResource	PaymentNotice request
identifier	Σ	0..*	Identifier	Business Identifier
ruleset	Σ	0..1	Coding	Resource version Ruleset Codes (Example)
originalRuleset	Σ	0..1	Coding	Original version Ruleset Codes (Example)
created	Σ	0..1	dateTime	Creation date
target	Σ	0..1	Reference(Organization)	Insurer or Regulatory body
provider	Σ	0..1	Reference(Practitioner)	Responsible practitioner
organization	Σ	0..1	Reference(Organization)	Responsible organization
request	Σ	0..1	Reference(Any)	Request reference
response	Σ	0..1	Reference(Any)	Response reference
paymentStatus	Σ	1..1	Coding	Status of the payment Payment Status Codes (Example)
statusDate	Σ	0..1	date	Payment or clearing date
Documentation for this format

UML Diagram

XML Template

<PaymentNotice xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business Identifier --></identifier>
 <ruleset><!-- 0..1 Coding Resource version --></ruleset>
 <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset>
 <created value="[dateTime]"/><!-- 0..1 Creation date -->
 <target><!-- 0..1 Reference(Organization) Insurer or Regulatory body --></target>
 <provider><!-- 0..1 Reference(Practitioner) Responsible practitioner --></provider>
 <organization><!-- 0..1 Reference(Organization) Responsible organization --></organization>
 <request><!-- 0..1 Reference(Any) Request reference --></request>
 <response><!-- 0..1 Reference(Any) Response reference --></response>
 <paymentStatus><!-- 1..1 Coding Status of the payment --></paymentStatus>
 <statusDate value="[date]"/><!-- 0..1 Payment or clearing date -->
</PaymentNotice>

JSON Template

{
  "resourceType" : "PaymentNotice",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifier
  "ruleset" : { Coding }, // Resource version
  "originalRuleset" : { Coding }, // Original version
  "created" : "<dateTime>", // Creation date
  "target" : { Reference(Organization) }, // Insurer or Regulatory body
  "provider" : { Reference(Practitioner) }, // Responsible practitioner
  "organization" : { Reference(Organization) }, // Responsible organization
  "request" : { Reference(Any) }, // Request reference
  "response" : { Reference(Any) }, // Response reference
  "paymentStatus" : { Coding }, // R!  Status of the payment
  "statusDate" : "<date>" // Payment or clearing date
}

Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire

7.9.2.1 Terminology Bindings

Path	Definition	Type	Reference
PaymentNotice.ruleset PaymentNotice.originalRuleset	The static and dynamic model to which contents conform, which may be business version or standard/version.	Example	Ruleset Codes
PaymentNotice.paymentStatus	The payment conveyance status codes	Example	Payment Status Codes

Path

Definition

Type

Reference

PaymentNotice.ruleset
PaymentNotice.originalRuleset

The static and dynamic model to which contents conform, which may be business version or standard/version.

Example

Ruleset Codes

PaymentNotice.paymentStatus

The payment conveyance status codes

Example

Payment Status Codes

7.9.3 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name	Type	Description	Paths
created	date	Creation date fro the notice	PaymentNotice.created
identifier	token	The business identifier of the notice	PaymentNotice.identifier
organization	reference	The organization who generated this resource	PaymentNotice.organization (Organization)
paymentstatus	token	The type of payment notice	PaymentNotice.paymentStatus
provider	reference	The reference to the provider	PaymentNotice.provider (Practitioner)
request	reference	The Claim	PaymentNotice.request (Any)
response	reference	The ClaimResponse	PaymentNotice.response (Any)
statusdate	date	The date of the payment action	PaymentNotice.statusDate