STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). 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

Financial Management Work GroupMaturity Level: 0Compartments: 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.

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 Codes (Example)
... originalRuleset Σ0..1CodingOriginal version
Ruleset Codes (Example)
... created Σ0..1dateTimeCreation date
... target[x] Σ0..1Insurer or Regulatory body
.... targetIdentifierIdentifier
.... targetReferenceReference(Organization)
... provider[x] Σ0..1Responsible practitioner
.... providerIdentifierIdentifier
.... providerReferenceReference(Practitioner)
... organization[x] Σ0..1Responsible organization
.... organizationIdentifierIdentifier
.... organizationReferenceReference(Organization)
... request[x] Σ0..1Request reference
.... requestIdentifierIdentifier
.... requestReferenceReference(Any)
... response[x] Σ0..1Response reference
.... responseIdentifierIdentifier
.... responseReferenceReference(Any)
... paymentStatus Σ1..1CodingStatus of the payment
Payment Status Codes (Example)
... statusDate Σ0..1datePayment or clearing date

doco Documentation for this format

UML Diagram

PaymentNotice (DomainResource)The Response business identifieridentifier : Identifier [0..*]The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resourcesruleset : Coding [0..1] « The static and dynamic model to which contents conform, which may be business version or standard/version. (Strength=Example)Ruleset ?? »The style (standard) and version of the original material which was converted into this resourceoriginalRuleset : Coding [0..1] « The static and dynamic model to which contents conform, which may be business version or standard/version. (Strength=Example)Ruleset ?? »The date when this resource was createdcreated : dateTime [0..1]The Insurer who is target of the requesttarget[x] : Type [0..1] « Identifier|Reference(Organization) »The practitioner who is responsible for the services rendered to the patientprovider[x] : Type [0..1] « Identifier|Reference(Practitioner) »The organization which is responsible for the services rendered to the patientorganization[x] : Type [0..1] « Identifier|Reference(Organization) »Reference of resource to reverserequest[x] : Type [0..1] « Identifier|Reference(Any) »Reference of response to resource to reverseresponse[x] : Type [0..1] « Identifier|Reference(Any) »The payment status, typically paid: payment sent, cleared: payment receivedpaymentStatus : Coding [1..1] « The payment conveyance status codes (Strength=Example)Payment Status ?? »The date when the above payment action occurrredstatusDate : date [0..1]

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

{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[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
}

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. PaymentNotice ΣDomainResourcePaymentNotice request
... identifier Σ0..*IdentifierBusiness Identifier
... ruleset Σ0..1CodingResource version
Ruleset Codes (Example)
... originalRuleset Σ0..1CodingOriginal version
Ruleset Codes (Example)
... created Σ0..1dateTimeCreation date
... target[x] Σ0..1Insurer or Regulatory body
.... targetIdentifierIdentifier
.... targetReferenceReference(Organization)
... provider[x] Σ0..1Responsible practitioner
.... providerIdentifierIdentifier
.... providerReferenceReference(Practitioner)
... organization[x] Σ0..1Responsible organization
.... organizationIdentifierIdentifier
.... organizationReferenceReference(Organization)
... request[x] Σ0..1Request reference
.... requestIdentifierIdentifier
.... requestReferenceReference(Any)
... response[x] Σ0..1Response reference
.... responseIdentifierIdentifier
.... responseReferenceReference(Any)
... paymentStatus Σ1..1CodingStatus of the payment
Payment Status Codes (Example)
... statusDate Σ0..1datePayment or clearing date

doco Documentation for this format

UML Diagram

PaymentNotice (DomainResource)The Response business identifieridentifier : Identifier [0..*]The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resourcesruleset : Coding [0..1] « The static and dynamic model to which contents conform, which may be business version or standard/version. (Strength=Example)Ruleset ?? »The style (standard) and version of the original material which was converted into this resourceoriginalRuleset : Coding [0..1] « The static and dynamic model to which contents conform, which may be business version or standard/version. (Strength=Example)Ruleset ?? »The date when this resource was createdcreated : dateTime [0..1]The Insurer who is target of the requesttarget[x] : Type [0..1] « Identifier|Reference(Organization) »The practitioner who is responsible for the services rendered to the patientprovider[x] : Type [0..1] « Identifier|Reference(Practitioner) »The organization which is responsible for the services rendered to the patientorganization[x] : Type [0..1] « Identifier|Reference(Organization) »Reference of resource to reverserequest[x] : Type [0..1] « Identifier|Reference(Any) »Reference of response to resource to reverseresponse[x] : Type [0..1] « Identifier|Reference(Any) »The payment status, typically paid: payment sent, cleared: payment receivedpaymentStatus : Coding [1..1] « The payment conveyance status codes (Strength=Example)Payment Status ?? »The date when the above payment action occurrredstatusDate : date [0..1]

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

{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[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
}

 

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

7.9.2.1 Terminology Bindings

PathDefinitionTypeReference
PaymentNotice.ruleset
PaymentNotice.originalRuleset 		The static and dynamic model to which contents conform, which may be business version or standard/version.ExampleRuleset Codes
PaymentNotice.paymentStatus The payment conveyance status codesExamplePayment Status Codes

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
createddateCreation date fro the noticePaymentNotice.created
identifiertokenThe business identifier of the noticePaymentNotice.identifier
organizationidentifiertokenThe organization who generated this resourcePaymentNotice.organizationIdentifier
organizationreferencereferenceThe organization who generated this resourcePaymentNotice.organizationReference
(Organization)
paymentstatustokenThe type of payment noticePaymentNotice.paymentStatus
provideridentifiertokenThe reference to the providerPaymentNotice.providerIdentifier
providerreferencereferenceThe reference to the providerPaymentNotice.providerReference
(Practitioner)
requestidentifiertokenThe ClaimPaymentNotice.requestIdentifier
requestreferencereferenceThe ClaimPaymentNotice.requestReference
(Any)
responseidentifiertokenThe ClaimResponsePaymentNotice.responseIdentifier
responsereferencereferenceThe ClaimResponsePaymentNotice.responseReference
(Any)
statusdatedateThe date of the payment actionPaymentNotice.statusDate