DSTU2 Ballot Source

This page is part of the FHIR Specification (v0.5.0: DSTU 2 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

7.9 Resource PaymentNotice - Content

This resource maintained by the Financial Management Work Group

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

7.9.2 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. PaymentNotice DomainResourcePaymentNotice request
... identifier 0..*IdentifierBusiness Identifier
... ruleset 0..1CodingResource version
Ruleset (Example)
... originalRuleset 0..1CodingOriginal version
Ruleset (Example)
... created 0..1dateTimeCreation date
... target 0..1OrganizationInsurer or Regulatory body
... provider 0..1PractitionerResponsible practitioner
... organization 0..1OrganizationResponsible organization
... request 0..1AnyRequest reference
... response 0..1AnyResponse reference
... paymentStatus 1..1CodingStatus of the payment
PaymentStatus (Example)

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>
 <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>
</PaymentNotice>

JSON Template

{doco
  "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
}

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. PaymentNotice DomainResourcePaymentNotice request
... identifier 0..*IdentifierBusiness Identifier
... ruleset 0..1CodingResource version
Ruleset (Example)
... originalRuleset 0..1CodingOriginal version
Ruleset (Example)
... created 0..1dateTimeCreation date
... target 0..1OrganizationInsurer or Regulatory body
... provider 0..1PractitionerResponsible practitioner
... organization 0..1OrganizationResponsible organization
... request 0..1AnyRequest reference
... response 0..1AnyResponse reference
... paymentStatus 1..1CodingStatus of the payment
PaymentStatus (Example)

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>
 <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>
</PaymentNotice>

JSON Template

{doco
  "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
}

 

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

7.9.2.1 Terminology Bindings

PathDefinitionTypeReference
PaymentNotice.ruleset
PaymentNotice.originalRuleset 		The static and dynamic model to which contents conform, may be business version or standard and version.Examplehttp://hl7.org/fhir/vs/ruleset
PaymentNotice.paymentStatus The payment conveyance status codesExamplehttp://hl7.org/fhir/vs/payment-status

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.

NameTypeDescriptionPaths
identifiertokenThe business identifier of the EligibilityPaymentNotice.identifier