STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). 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	?!Σ	1..1	code	active \| cancelled \| draft \| entered-in-error PaymentNoticeStatus (Required)
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[x]		0..1		Insurer or Regulatory body
targetIdentifier			Identifier
targetReference			Reference(Organization)
provider[x]		0..1		Responsible practitioner
providerIdentifier			Identifier
providerReference			Reference(Practitioner)
organization[x]		0..1		Responsible organization
organizationIdentifier			Identifier
organizationReference			Reference(Organization)
request[x]		0..1		Request reference
requestIdentifier			Identifier
requestReference			Reference(Any)
response[x]		0..1		Response reference
responseIdentifier			Identifier
responseReference			Reference(Any)
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 (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]"/><!-- 1..1 active | cancelled | draft | entered-in-error -->
 <ruleset><!-- 0..1 Coding Resource version --></ruleset>
 <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset>
 <created value="[dateTime]"/><!-- 0..1 Creation date -->
 <target[x]><!-- 0..1 Identifier|Reference(Organization) Insurer or Regulatory body --></target[x]>
 <provider[x]><!-- 0..1 Identifier|Reference(Practitioner) Responsible practitioner --></provider[x]>
 <organization[x]><!-- 0..1 Identifier|Reference(Organization) Responsible organization --></organization[x]>
 <request[x]><!-- 0..1 Identifier|Reference(Any) Request reference --></request[x]>
 <response[x]><!-- 0..1 Identifier|Reference(Any) Response reference --></response[x]>
 <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
  "status" : "<code>", // R!  active | cancelled | draft | entered-in-error
  "ruleset" : { Coding }, // Resource version
  "originalRuleset" : { Coding }, // Original version
  "created" : "<dateTime>", // Creation date
  // target[x]: Insurer or Regulatory body. One of these 2:
  "targetIdentifier" : { Identifier },
  "targetReference" : { Reference(Organization) },
  // provider[x]: Responsible practitioner. One of these 2:
  "providerIdentifier" : { Identifier },
  "providerReference" : { Reference(Practitioner) },
  // organization[x]: Responsible organization. One of these 2:
  "organizationIdentifier" : { Identifier },
  "organizationReference" : { Reference(Organization) },
  // request[x]: Request reference. One of these 2:
  "requestIdentifier" : { Identifier },
  "requestReference" : { Reference(Any) },
  // response[x]: Response reference. One of these 2:
  "responseIdentifier" : { Identifier },
  "responseReference" : { Reference(Any) },
  "paymentStatus" : { Coding }, // R!  Status of the payment
  "statusDate" : "<date>" // Payment or clearing date
}

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 ]; # 1..1 active | cancelled | draft | entered-in-error
  fhir:PaymentNotice.ruleset [ Coding ]; # 0..1 Resource version
  fhir:PaymentNotice.originalRuleset [ Coding ]; # 0..1 Original version
  fhir:PaymentNotice.created [ dateTime ]; # 0..1 Creation date
  # PaymentNotice.target[x] : 0..1 Insurer or Regulatory body. One of these 2
    fhir:PaymentNotice.targetIdentifier [ Identifier ]
    fhir:PaymentNotice.targetReference [ Reference(Organization) ]
  # PaymentNotice.provider[x] : 0..1 Responsible practitioner. One of these 2
    fhir:PaymentNotice.providerIdentifier [ Identifier ]
    fhir:PaymentNotice.providerReference [ Reference(Practitioner) ]
  # PaymentNotice.organization[x] : 0..1 Responsible organization. One of these 2
    fhir:PaymentNotice.organizationIdentifier [ Identifier ]
    fhir:PaymentNotice.organizationReference [ Reference(Organization) ]
  # PaymentNotice.request[x] : 0..1 Request reference. One of these 2
    fhir:PaymentNotice.requestIdentifier [ Identifier ]
    fhir:PaymentNotice.requestReference [ Reference(Any) ]
  # PaymentNotice.response[x] : 0..1 Response reference. One of these 2
    fhir:PaymentNotice.responseIdentifier [ Identifier ]
    fhir:PaymentNotice.responseReference [ Reference(Any) ]
  fhir:PaymentNotice.paymentStatus [ Coding ]; # 1..1 Status of the payment
  fhir:PaymentNotice.statusDate [ date ]; # 0..1 Payment or clearing date
]

Changes since DSTU2

PaymentNotice

PaymentNotice.status

added

PaymentNotice.target[x]

Renamed from target to target[x]
Add Identifier

PaymentNotice.provider[x]

Renamed from provider to provider[x]
Add Identifier

PaymentNotice.organization[x]

Renamed from organization to organization[x]
Add Identifier

PaymentNotice.request[x]

Renamed from request to request[x]
Add Identifier

PaymentNotice.response[x]

Renamed from response to response[x]
Add Identifier

PaymentNotice.statusDate

added

See the Full Difference for further information

Structure

Name	Flags	Card.	Type	Description & Constraints
PaymentNotice			DomainResource	PaymentNotice request
identifier		0..*	Identifier	Business Identifier
status	?!Σ	1..1	code	active \| cancelled \| draft \| entered-in-error PaymentNoticeStatus (Required)
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[x]		0..1		Insurer or Regulatory body
targetIdentifier			Identifier
targetReference			Reference(Organization)
provider[x]		0..1		Responsible practitioner
providerIdentifier			Identifier
providerReference			Reference(Practitioner)
organization[x]		0..1		Responsible organization
organizationIdentifier			Identifier
organizationReference			Reference(Organization)
request[x]		0..1		Request reference
requestIdentifier			Identifier
requestReference			Reference(Any)
response[x]		0..1		Response reference
responseIdentifier			Identifier
responseReference			Reference(Any)
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 (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]"/><!-- 1..1 active | cancelled | draft | entered-in-error -->
 <ruleset><!-- 0..1 Coding Resource version --></ruleset>
 <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset>
 <created value="[dateTime]"/><!-- 0..1 Creation date -->
 <target[x]><!-- 0..1 Identifier|Reference(Organization) Insurer or Regulatory body --></target[x]>
 <provider[x]><!-- 0..1 Identifier|Reference(Practitioner) Responsible practitioner --></provider[x]>
 <organization[x]><!-- 0..1 Identifier|Reference(Organization) Responsible organization --></organization[x]>
 <request[x]><!-- 0..1 Identifier|Reference(Any) Request reference --></request[x]>
 <response[x]><!-- 0..1 Identifier|Reference(Any) Response reference --></response[x]>
 <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
  "status" : "<code>", // R!  active | cancelled | draft | entered-in-error
  "ruleset" : { Coding }, // Resource version
  "originalRuleset" : { Coding }, // Original version
  "created" : "<dateTime>", // Creation date
  // target[x]: Insurer or Regulatory body. One of these 2:
  "targetIdentifier" : { Identifier },
  "targetReference" : { Reference(Organization) },
  // provider[x]: Responsible practitioner. One of these 2:
  "providerIdentifier" : { Identifier },
  "providerReference" : { Reference(Practitioner) },
  // organization[x]: Responsible organization. One of these 2:
  "organizationIdentifier" : { Identifier },
  "organizationReference" : { Reference(Organization) },
  // request[x]: Request reference. One of these 2:
  "requestIdentifier" : { Identifier },
  "requestReference" : { Reference(Any) },
  // response[x]: Response reference. One of these 2:
  "responseIdentifier" : { Identifier },
  "responseReference" : { Reference(Any) },
  "paymentStatus" : { Coding }, // R!  Status of the payment
  "statusDate" : "<date>" // Payment or clearing date
}

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 ]; # 1..1 active | cancelled | draft | entered-in-error
  fhir:PaymentNotice.ruleset [ Coding ]; # 0..1 Resource version
  fhir:PaymentNotice.originalRuleset [ Coding ]; # 0..1 Original version
  fhir:PaymentNotice.created [ dateTime ]; # 0..1 Creation date
  # PaymentNotice.target[x] : 0..1 Insurer or Regulatory body. One of these 2
    fhir:PaymentNotice.targetIdentifier [ Identifier ]
    fhir:PaymentNotice.targetReference [ Reference(Organization) ]
  # PaymentNotice.provider[x] : 0..1 Responsible practitioner. One of these 2
    fhir:PaymentNotice.providerIdentifier [ Identifier ]
    fhir:PaymentNotice.providerReference [ Reference(Practitioner) ]
  # PaymentNotice.organization[x] : 0..1 Responsible organization. One of these 2
    fhir:PaymentNotice.organizationIdentifier [ Identifier ]
    fhir:PaymentNotice.organizationReference [ Reference(Organization) ]
  # PaymentNotice.request[x] : 0..1 Request reference. One of these 2
    fhir:PaymentNotice.requestIdentifier [ Identifier ]
    fhir:PaymentNotice.requestReference [ Reference(Any) ]
  # PaymentNotice.response[x] : 0..1 Response reference. One of these 2
    fhir:PaymentNotice.responseIdentifier [ Identifier ]
    fhir:PaymentNotice.responseReference [ Reference(Any) ]
  fhir:PaymentNotice.paymentStatus [ Coding ]; # 1..1 Status of the payment
  fhir:PaymentNotice.statusDate [ date ]; # 0..1 Payment or clearing date
]

Changes since DSTU2

PaymentNotice

PaymentNotice.status

added

PaymentNotice.target[x]

Renamed from target to target[x]
Add Identifier

PaymentNotice.provider[x]

Renamed from provider to provider[x]
Add Identifier

PaymentNotice.organization[x]

Renamed from organization to organization[x]
Add Identifier

PaymentNotice.request[x]

Renamed from request to request[x]
Add Identifier

PaymentNotice.response[x]

Renamed from response to response[x]
Add Identifier

PaymentNotice.statusDate

added

See the Full Difference for further information

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

13.9.2.1 Terminology Bindings

Path	Definition	Type	Reference
PaymentNotice.status	A code specifying the state of the resource instance.	Required	PaymentNoticeStatus
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.status

A code specifying the state of the resource instance.

Required

PaymentNoticeStatus

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

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
created	date	Creation date fro the notice	PaymentNotice.created
identifier	token	The business identifier of the notice	PaymentNotice.identifier
organization-identifier	token	The organization who generated this resource	PaymentNotice.organizationIdentifier
organization-reference	reference	The organization who generated this resource	PaymentNotice.organizationReference (Organization)
payment-status	token	The type of payment notice	PaymentNotice.paymentStatus
provider-identifier	token	The reference to the provider	PaymentNotice.providerIdentifier
provider-reference	reference	The reference to the provider	PaymentNotice.providerReference (Practitioner)
request-identifier	token	The Claim	PaymentNotice.requestIdentifier
request-reference	reference	The Claim	PaymentNotice.requestReference (Any)
response-identifier	token	The ClaimResponse	PaymentNotice.responseIdentifier
response-reference	reference	The ClaimResponse	PaymentNotice.responseReference (Any)
statusdate	date	The date of the payment action	PaymentNotice.statusDate