STU3 Candidate

This page is part of the FHIR Specification (v1.8.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

13.9 Resource PaymentNotice - Content

Financial Management

Work Group

Maturity Level: 1

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.

13.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 Providers and Payors 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 Insurance Exchanges may use this to advise Payors of premium payment.

Payors and /or Providers may have the need to advise Providers and/or regulators 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.

Structure

Name	Flags	Card.	Type	Description & Constraints
PaymentNotice			DomainResource	PaymentNotice request
identifier		0..*	Identifier	Business Identifier
status	?!Σ	0..1	code	active \| cancelled \| draft \| entered-in-error Financial Resource Status Codes (Required)
request		0..1	Reference(Any)	Request reference
response		0..1	Reference(Any)	Response reference
statusDate		0..1	date	Payment or clearing date
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
paymentStatus		0..1	CodeableConcept	Status of the payment Payment Status Codes (Example)
Documentation for this format

UML Diagram (Legend)

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>
 <status value="[code]"/><!-- 0..1 active | cancelled | draft | entered-in-error -->
 <request><!-- 0..1 Reference(Any) Request reference --></request>
 <response><!-- 0..1 Reference(Any) Response reference --></response>
 <statusDate value="[date]"/><!-- 0..1 Payment or clearing date -->
 <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>
 <paymentStatus><!-- 0..1 CodeableConcept Status of the payment --></paymentStatus>
</PaymentNotice>

JSON Template

{
  "resourceType" : "PaymentNotice",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifier
  "status" : "<code>", // active | cancelled | draft | entered-in-error
  "request" : { Reference(Any) }, // Request reference
  "response" : { Reference(Any) }, // Response reference
  "statusDate" : "<date>", // Payment or clearing date
  "created" : "<dateTime>", // Creation date
  "target" : { Reference(Organization) }, // Insurer or Regulatory body
  "provider" : { Reference(Practitioner) }, // Responsible practitioner
  "organization" : { Reference(Organization) }, // Responsible organization
  "paymentStatus" : { CodeableConcept } // Status of the payment
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:PaymentNotice;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:PaymentNotice.identifier [ Identifier ], ... ; # 0..* Business Identifier
  fhir:PaymentNotice.status [ code ]; # 0..1 active | cancelled | draft | entered-in-error
  fhir:PaymentNotice.request [ Reference(Any) ]; # 0..1 Request reference
  fhir:PaymentNotice.response [ Reference(Any) ]; # 0..1 Response reference
  fhir:PaymentNotice.statusDate [ date ]; # 0..1 Payment or clearing date
  fhir:PaymentNotice.created [ dateTime ]; # 0..1 Creation date
  fhir:PaymentNotice.target [ Reference(Organization) ]; # 0..1 Insurer or Regulatory body
  fhir:PaymentNotice.provider [ Reference(Practitioner) ]; # 0..1 Responsible practitioner
  fhir:PaymentNotice.organization [ Reference(Organization) ]; # 0..1 Responsible organization
  fhir:PaymentNotice.paymentStatus [ CodeableConcept ]; # 0..1 Status of the payment
]

Changes since DSTU2

PaymentNotice

PaymentNotice.status

added Element

PaymentNotice.statusDate

added Element

PaymentNotice.paymentStatus

Min Cardinality changed from 1 to 0
Type changed from Coding to CodeableConcept

PaymentNotice.ruleset

deleted

PaymentNotice.originalRuleset

deleted

See the Full Difference for further information

Structure

Name	Flags	Card.	Type	Description & Constraints
PaymentNotice			DomainResource	PaymentNotice request
identifier		0..*	Identifier	Business Identifier
status	?!Σ	0..1	code	active \| cancelled \| draft \| entered-in-error Financial Resource Status Codes (Required)
request		0..1	Reference(Any)	Request reference
response		0..1	Reference(Any)	Response reference
statusDate		0..1	date	Payment or clearing date
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
paymentStatus		0..1	CodeableConcept	Status of the payment Payment Status Codes (Example)
Documentation for this format

UML Diagram (Legend)

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>
 <status value="[code]"/><!-- 0..1 active | cancelled | draft | entered-in-error -->
 <request><!-- 0..1 Reference(Any) Request reference --></request>
 <response><!-- 0..1 Reference(Any) Response reference --></response>
 <statusDate value="[date]"/><!-- 0..1 Payment or clearing date -->
 <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>
 <paymentStatus><!-- 0..1 CodeableConcept Status of the payment --></paymentStatus>
</PaymentNotice>

JSON Template

{
  "resourceType" : "PaymentNotice",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifier
  "status" : "<code>", // active | cancelled | draft | entered-in-error
  "request" : { Reference(Any) }, // Request reference
  "response" : { Reference(Any) }, // Response reference
  "statusDate" : "<date>", // Payment or clearing date
  "created" : "<dateTime>", // Creation date
  "target" : { Reference(Organization) }, // Insurer or Regulatory body
  "provider" : { Reference(Practitioner) }, // Responsible practitioner
  "organization" : { Reference(Organization) }, // Responsible organization
  "paymentStatus" : { CodeableConcept } // Status of the payment
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:PaymentNotice;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:PaymentNotice.identifier [ Identifier ], ... ; # 0..* Business Identifier
  fhir:PaymentNotice.status [ code ]; # 0..1 active | cancelled | draft | entered-in-error
  fhir:PaymentNotice.request [ Reference(Any) ]; # 0..1 Request reference
  fhir:PaymentNotice.response [ Reference(Any) ]; # 0..1 Response reference
  fhir:PaymentNotice.statusDate [ date ]; # 0..1 Payment or clearing date
  fhir:PaymentNotice.created [ dateTime ]; # 0..1 Creation date
  fhir:PaymentNotice.target [ Reference(Organization) ]; # 0..1 Insurer or Regulatory body
  fhir:PaymentNotice.provider [ Reference(Practitioner) ]; # 0..1 Responsible practitioner
  fhir:PaymentNotice.organization [ Reference(Organization) ]; # 0..1 Responsible organization
  fhir:PaymentNotice.paymentStatus [ CodeableConcept ]; # 0..1 Status of the payment
]

Changes since DSTU2

PaymentNotice

PaymentNotice.status

added Element

PaymentNotice.statusDate

added Element

PaymentNotice.paymentStatus

Min Cardinality changed from 1 to 0
Type changed from Coding to CodeableConcept

PaymentNotice.ruleset

deleted

PaymentNotice.originalRuleset

deleted

See the Full Difference for further information

Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle), JSON-LD (for RDF as JSON-LD),

13.9.2.1 Terminology Bindings

Path	Definition	Type	Reference
PaymentNotice.status	A code specifying the state of the resource instance.	Required	Financial Resource Status Codes
PaymentNotice.paymentStatus	The payment conveyance status codes	Example	Payment Status Codes

Path

Definition

Type

Reference

PaymentNotice.status

A code specifying the state of the resource instance.

Required

Financial Resource Status Codes

PaymentNotice.paymentStatus

The payment conveyance status codes

Example

Payment Status Codes

13.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	In Common
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)
payment-status	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