FHIR Release 3 (STU) R4 Ballot #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.0.2: STU 3). (v3.5.0: R4 Ballot #2). 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.8 Resource PaymentNotice - Content

Financial Management Work Group Maturity Level : 2   Trial Use Compartments : Practitioner

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

13.8.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 payers to advise the Provider provider or regulatory bodies of the state of a payment (cheque (check in the mail/EFT sent, payment cashed, payment cancelled). canceled). Employers or Insurance Exchanges may use this to advise payors payers of premium payment.

Payors and /or Payers 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 payers that premium payments have been issued and settled.

13.8.2 Resource Content

Structure

Name Flags Card. Type Description & Constraints doco
. . PaymentNotice TU DomainResource PaymentNotice request
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . 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 | PractitionerRole ( | Organization ) Responsible organization practitioner
. . . paymentStatus 0..1 CodeableConcept Whether payment has been sent or cleared
Payment Status Codes ( Example )

doco Documentation for this format

XML Template 

<

<PaymentNotice xmlns="http://hl7.org/fhir"> doco

 <!-- 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>
 <</organization>

 <provider><!-- 0..1 Reference(Practitioner|PractitionerRole|Organization) Responsible practitioner --></provider>

 <paymentStatus><!-- 0..1 CodeableConcept Whether payment has been sent or cleared --></paymentStatus>
</PaymentNotice>

Turtle Template 

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


[ 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:

  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:
  fhir:

  fhir:PaymentNotice.provider [ Reference(Practitioner|PractitionerRole|Organization) ]; # 0..1 Responsible practitioner

  fhir:PaymentNotice.paymentStatus [ CodeableConcept ]; # 0..1 Whether payment has been sent or cleared
]

Changes since DSTU2 R3

PaymentNotice.status
PaymentNotice Added Element PaymentNotice.statusDate Added Element
PaymentNotice.paymentStatus PaymentNotice.provider
  • Min Cardinality changed from 1 to 0 Type changed from Coding Reference(Practitioner) to CodeableConcept PaymentNotice.ruleset deleted Reference(Practitioner|PractitionerRole|Organization)
PaymentNotice.originalRuleset PaymentNotice.organization
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON .

See R3 <--> R4 Conversion Maps (status = 1 test that all execute ok. 1 fail round-trip testing and 1 r3 resources are invalid (0 errors). )

Structure

Name Flags Card. Type Description & Constraints doco
. . PaymentNotice TU DomainResource PaymentNotice request
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . 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 | PractitionerRole ( | Organization ) Responsible organization practitioner
. . . paymentStatus 0..1 CodeableConcept Whether payment has been sent or cleared
Payment Status Codes ( Example )

doco Documentation for this format

XML Template 

<

<PaymentNotice xmlns="http://hl7.org/fhir"> doco

 <!-- 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>
 <</organization>

 <provider><!-- 0..1 Reference(Practitioner|PractitionerRole|Organization) Responsible practitioner --></provider>

 <paymentStatus><!-- 0..1 CodeableConcept Whether payment has been sent or cleared --></paymentStatus>
</PaymentNotice>

Turtle Template 

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


[ 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:

  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:
  fhir:

  fhir:PaymentNotice.provider [ Reference(Practitioner|PractitionerRole|Organization) ]; # 0..1 Responsible practitioner

  fhir:PaymentNotice.paymentStatus [ CodeableConcept ]; # 0..1 Whether payment has been sent or cleared
]

Changes since DSTU2 Release 3

PaymentNotice.status
PaymentNotice Added Element PaymentNotice.statusDate Added Element
PaymentNotice.paymentStatus PaymentNotice.provider
  • Min Cardinality changed from 1 to 0 Type changed from Coding Reference(Practitioner) to CodeableConcept PaymentNotice.ruleset deleted Reference(Practitioner|PractitionerRole|Organization)
PaymentNotice.originalRuleset PaymentNotice.organization
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON .

See R3 <--> R4 Conversion Maps (status = 1 test that all execute ok. 1 fail round-trip testing and 1 r3 resources are invalid (0 errors). )

 

Alternate See the Profiles & Extensions and the alternate definitions: Master Definition ( XML , + JSON ), , XML Schema / Schematron (for ) + JSON Schema , ShEx (for Turtle ) + see the extensions & the dependency analysis

13.8.2.1 Terminology Bindings

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

13.8.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.

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