Current Build

13.8 Resource PaymentNotice - Content

Financial Management Work GroupMaturity Level: 2 Trial UseCompartments: Practitioner

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

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. PaymentNotice DomainResourcePaymentNotice request
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier 0..*IdentifierBusiness Identifier
... status ?!Σ0..1codeactive | cancelled | draft | entered-in-error
Financial Resource Status Codes (Required)
... request 0..1Reference(Any)Request reference
... response 0..1Reference(Any)Response reference
... statusDate 0..1datePayment or clearing date
... created 0..1dateTimeCreation date
... target 0..1Reference(Organization)Insurer or Regulatory body
... provider 0..1Reference(Practitioner)Responsible practitioner
... organization 0..1Reference(Organization)Responsible organization
... paymentStatus 0..1CodeableConceptWhether 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><!-- 0..1 Reference(Practitioner) Responsible practitioner --></provider>
 <organization><!-- 0..1 Reference(Organization) Responsible organization --></organization>
 <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: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 Whether payment has been sent or cleared
]

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

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. PaymentNotice DomainResourcePaymentNotice request
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier 0..*IdentifierBusiness Identifier
... status ?!Σ0..1codeactive | cancelled | draft | entered-in-error
Financial Resource Status Codes (Required)
... request 0..1Reference(Any)Request reference
... response 0..1Reference(Any)Response reference
... statusDate 0..1datePayment or clearing date
... created 0..1dateTimeCreation date
... target 0..1Reference(Organization)Insurer or Regulatory body
... provider 0..1Reference(Practitioner)Responsible practitioner
... organization 0..1Reference(Organization)Responsible organization
... paymentStatus 0..1CodeableConceptWhether 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><!-- 0..1 Reference(Practitioner) Responsible practitioner --></provider>
 <organization><!-- 0..1 Reference(Organization) Responsible organization --></organization>
 <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: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 Whether payment has been sent or cleared
]

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

This analysis is available as XML or JSON.

 

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

PathDefinitionTypeReference
PaymentNotice.status A code specifying the state of the resource instance.RequiredFinancial Resource Status Codes
PaymentNotice.paymentStatus The payment conveyance status codesExamplePayment Status Codes

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

NameTypeDescriptionExpressionIn Common
createddateCreation date fro the noticePaymentNotice.created
identifiertokenThe business identifier of the noticePaymentNotice.identifier
organizationreferenceThe organization who generated this resourcePaymentNotice.organization
(Organization)
payment-statustokenThe type of payment noticePaymentNotice.paymentStatus
providerreferenceThe reference to the providerPaymentNotice.provider
(Practitioner)
requestreferenceThe ClaimPaymentNotice.request
(Any)
responsereferenceThe ClaimResponsePaymentNotice.response
(Any)
statustokenThe status of the payment noticePaymentNotice.status
statusdatedateThe date of the payment actionPaymentNotice.statusDate