DSTU2 STU 3 Candidate
This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is

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 . For a full list of available versions, see the Directory of published versions . Page versions: . Page versions: R5 R4B R4 R3 R2

7.9 Resource PaymentNotice - Content Resource PaymentNotice - Content

This resource provides the status of the payment for goods and services rendered, and the request and response resource references.
Financial Management Financial Management Work Group Work Group Maturity Level : 0 Maturity Level : 0 Compartments : Not linked to any defined 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.

7.9.1 Scope and Usage 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

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 Resource Content

Structure

Insurer or Regulatory body Responsible practitioner Responsible organization Request reference Response reference
Name Flags Card. Type Description & Constraints Description & Constraints doco
. . PaymentNotice Σ DomainResource PaymentNotice request PaymentNotice request
. . . identifier Σ 0..* Identifier Business Identifier Business Identifier
. . . ruleset Σ 0..1 Coding Resource version Resource version
Ruleset Codes ( Ruleset Codes ( Example )
. . . originalRuleset Σ 0..1 Coding Original version Original version
Ruleset Codes ( Ruleset Codes ( Example )
. . . created Σ 0..1 dateTime Creation date Creation date
. . target . target[x] Σ 0..1 Insurer or Regulatory body
.... targetIdentifier Identifier
.... targetReference Reference ( Organization )
. . provider . provider[x] Σ 0..1 Responsible practitioner
.... providerIdentifier Identifier
.... providerReference Reference ( Practitioner )
. . organization . organization[x] Σ 0..1 Responsible organization
.... organizationIdentifier Identifier
.... organizationReference Reference ( Organization )
. . request . request[x] Σ 0..1 Request reference
.... requestIdentifier Identifier
.... requestReference Reference ( Any )
. . response . response[x] Σ 0..1 Response reference
.... responseIdentifier Identifier
.... responseReference Reference ( Any )
. . . paymentStatus Σ 1..1 Coding Status of the payment Status of the payment
Payment Status Codes ( Payment Status Codes ( Example )
. . . statusDate Σ 0..1 date Payment or clearing date

Documentation for this format doco Documentation for this format

UML Diagram UML Diagram

PaymentNotice ( ( DomainResource ) The Response business identifier The Response business identifier identifier : : Identifier [0..*] [0..*] The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources ruleset : : Coding [0..1] « [0..1] « The static and dynamic model to which contents conform, which may be business version or standard/version. (Strength=Example) The static and dynamic model to which contents conform, which may be business version or standard/version. (Strength=Example) Ruleset ?? » Ruleset ?? » The style (standard) and version of the original material which was converted into this resource The style (standard) and version of the original material which was converted into this resource originalRuleset : : Coding [0..1] « [0..1] « The static and dynamic model to which contents conform, which may be business version or standard/version. (Strength=Example) The static and dynamic model to which contents conform, which may be business version or standard/version. (Strength=Example) Ruleset ?? » Ruleset ?? » The date when this resource was created The date when this resource was created created : : dateTime [0..1] [0..1] The Insurer who is target of the request The Insurer who is target of the request target target[x] : Type [0..1] « Identifier : | Reference [0..1] « ( Organization » ) » The practitioner who is responsible for the services rendered to the patient The practitioner who is responsible for the services rendered to the patient provider provider[x] : Type [0..1] « Identifier : | Reference [0..1] « ( Practitioner » ) » The organization which is responsible for the services rendered to the patient The organization which is responsible for the services rendered to the patient organization organization[x] : Type [0..1] « Identifier : | Reference [0..1] « ( Organization » ) » Reference of resource to reverse Reference of resource to reverse request request[x] : Type [0..1] « Identifier : | Reference [0..1] « ( Any » ) » Reference of response to resource to reverse Reference of response to resource to reverse response response[x] : Type [0..1] « Identifier : | Reference [0..1] « ( Any » ) » The payment status, typically paid: payment sent, cleared: payment received The payment status, typically paid: payment sent, cleared: payment received paymentStatus : : Coding [1..1] « [1..1] « The payment conveyance status codes (Strength=Example) The payment conveyance status codes (Strength=Example) Payment Status ?? » Payment Status ?? » The date when the above payment action occurrred statusDate : date [0..1]

XML Template 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>
 <</provider>
 <</organization>
 <</request>
 <</response>

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

Insurer or Regulatory body Responsible practitioner Responsible organization Request reference Response reference
Name Flags Card. Type Description & Constraints Description & Constraints doco
. . PaymentNotice Σ DomainResource PaymentNotice request PaymentNotice request
. . . identifier Σ 0..* Identifier Business Identifier Business Identifier
. . . ruleset Σ 0..1 Coding Resource version Resource version
Ruleset Codes ( Ruleset Codes ( Example )
. . . originalRuleset Σ 0..1 Coding Original version Original version
Ruleset Codes ( Ruleset Codes ( Example )
. . . created Σ 0..1 dateTime Creation date Creation date
. . target . target[x] Σ 0..1 Insurer or Regulatory body
.... targetIdentifier Identifier
.... targetReference Reference ( Organization )
. . provider . provider[x] Σ 0..1 Responsible practitioner
.... providerIdentifier Identifier
.... providerReference Reference ( Practitioner )
. . organization . organization[x] Σ 0..1 Responsible organization
.... organizationIdentifier Identifier
.... organizationReference Reference ( Organization )
. . request . request[x] Σ 0..1 Request reference
.... requestIdentifier Identifier
.... requestReference Reference ( Any )
. . response . response[x] Σ 0..1 Response reference
.... responseIdentifier Identifier
.... responseReference Reference ( Any )
. . . paymentStatus Σ 1..1 Coding Status of the payment Status of the payment
Payment Status Codes ( Payment Status Codes ( Example )
. . . statusDate Σ 0..1 date Payment or clearing date

Documentation for this format doco Documentation for this format

UML Diagram UML Diagram

PaymentNotice ( ( DomainResource ) The Response business identifier The Response business identifier identifier : : Identifier [0..*] [0..*] The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources ruleset : : Coding [0..1] « [0..1] « The static and dynamic model to which contents conform, which may be business version or standard/version. (Strength=Example) The static and dynamic model to which contents conform, which may be business version or standard/version. (Strength=Example) Ruleset ?? » Ruleset ?? » The style (standard) and version of the original material which was converted into this resource The style (standard) and version of the original material which was converted into this resource originalRuleset : : Coding [0..1] « [0..1] « The static and dynamic model to which contents conform, which may be business version or standard/version. (Strength=Example) The static and dynamic model to which contents conform, which may be business version or standard/version. (Strength=Example) Ruleset ?? » Ruleset ?? » The date when this resource was created The date when this resource was created created : : dateTime [0..1] [0..1] The Insurer who is target of the request The Insurer who is target of the request target target[x] : Type [0..1] « Identifier : | Reference [0..1] « ( Organization » ) » The practitioner who is responsible for the services rendered to the patient The practitioner who is responsible for the services rendered to the patient provider provider[x] : Type [0..1] « Identifier : | Reference [0..1] « ( Practitioner » ) » The organization which is responsible for the services rendered to the patient The organization which is responsible for the services rendered to the patient organization organization[x] : Type [0..1] « Identifier : | Reference [0..1] « ( Organization » ) » Reference of resource to reverse Reference of resource to reverse request request[x] : Type [0..1] « Identifier : | Reference [0..1] « ( Any » ) » Reference of response to resource to reverse Reference of response to resource to reverse response response[x] : Type [0..1] « Identifier : | Reference [0..1] « ( Any » ) » The payment status, typically paid: payment sent, cleared: payment received The payment status, typically paid: payment sent, cleared: payment received paymentStatus : : Coding [1..1] « [1..1] « The payment conveyance status codes (Strength=Example) The payment conveyance status codes (Strength=Example) Payment Status ?? » Payment Status ?? » The date when the above payment action occurrred statusDate : date [0..1]

XML Template 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>
 <</provider>
 <</organization>
 <</request>
 <</response>

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

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

7.9.2.1 Terminology Bindings Terminology Bindings

Path Definition Type Reference
PaymentNotice.ruleset
PaymentNotice.originalRuleset PaymentNotice.originalRuleset 		The static and dynamic model to which contents conform, which may be business version or standard/version. The static and dynamic model to which contents conform, which may be business version or standard/version. Example Ruleset Codes Ruleset Codes
PaymentNotice.paymentStatus PaymentNotice.paymentStatus The payment conveyance status codes The payment conveyance status codes Example Payment Status Codes Payment Status Codes

7.9.3 Search Parameters Search Parameters Search parameters for this resource. The common parameters also apply. See

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

© HL7.org 2011+. FHIR DSTU2 (v1.0.2-7202) generated on Sat, Oct 24, 2015 07:43+1100. Links: Search
Name Type Description Paths
created date Creation date fro the notice PaymentNotice.created
identifier token The business identifier of the Eligibility The business identifier of the notice PaymentNotice.identifier
organizationidentifier token | Version History The organization who generated this resource PaymentNotice.organizationIdentifier
organizationreference reference | Table of Contents The organization who generated this resource PaymentNotice.organizationReference
( Organization | Compare to DSTU1 )
paymentstatus token | The type of payment notice PaymentNotice.paymentStatus
provideridentifier token | Propose a change The reference to the provider PaymentNotice.providerIdentifier
providerreference reference The reference to the provider PaymentNotice.providerReference
( Practitioner try { var currentTabIndex = sessionStorage.getItem('fhir-resource-tab-index'); } catch(exception){ } if (!currentTabIndex) currentTabIndex = '0'; $( '#tabs' ).tabs({ active: currentTabIndex, activate: function( event, ui ) { var active = $('.selector').tabs('option', 'active'); currentTabIndex = ui.newTab.index(); document.activeElement.blur(); try { sessionStorage.setItem('fhir-resource-tab-index', currentTabIndex); } catch(exception){ } } });
requestidentifier token The Claim PaymentNotice.requestIdentifier
requestreference reference The Claim PaymentNotice.requestReference
(Any)
responseidentifier token The ClaimResponse PaymentNotice.responseIdentifier
responsereference reference The ClaimResponse PaymentNotice.responseReference
(Any)
statusdate date The date of the payment action PaymentNotice.statusDate