DSTU2 STU 3 Ballot
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.6.0: STU 3 Ballot 4). 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 13.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 : 1 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 13.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

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.

7.9.2 Resource Content 13.9.2 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 . status ?! Σ 0..1 1..1 Coding code Resource version active | cancelled | draft | entered-in-error
Ruleset Codes ( Example PaymentNoticeStatus ( Required )
. . originalRuleset . ruleset 0..1 Coding Resource version
Σ 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 0..1 Identifier
. . . . targetReference Reference ( Organization )
. . provider . provider[x] 0..1 Responsible practitioner
.... providerIdentifier 0..1 Identifier
.... providerReference Reference ( Practitioner )
. . organization . organization[x] 0..1 Responsible organization
.... organizationIdentifier 0..1 Identifier
. . . . organizationReference Reference ( Organization )
. . request . request[x] 0..1 Request reference
. . . . requestIdentifier 0..1 Identifier
. . . . requestReference Reference ( Any )
. . response . response[x] 0..1 Response reference
.... responseIdentifier 0..1 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 ( Legend )

PaymentNotice ( ( DomainResource ) The Response business identifier The notice business identifier identifier : : Identifier [0..*] [0..*] The status of the resource instance (this element modifies the meaning of other elements) status : code [1..1] « A code specifying the state of the resource instance. (Strength=Required) PaymentNoticeStatus ! » 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 for which payment is being made request request[x] : Type [0..1] « Identifier : | Reference [0..1] « ( Any » ) » Reference of response to resource to reverse Reference of response to resource for which payment is being made 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>
 <</ruleset>
 <</originalRuleset>
 <
 <</target>
 <</provider>
 <</organization>
 <</request>
 <</response>
 <</paymentStatus>

 <identifier><!-- 0..* Identifier Business Identifier --></identifier>
 <status value="[code]"/><!-- 1..1 active | cancelled | draft | entered-in-error -->
 <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 JSON Template { "resourceType" : "", 

{doco
  "resourceType" : "PaymentNotice",

  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "

  "identifier" : [{ Identifier }], // Business Identifier
  "status" : "<code>", // R!  active | cancelled | draft | entered-in-error
  "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

}

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 ]; # 1..1 active | cancelled | draft | entered-in-error
  fhir:PaymentNotice.ruleset [ Coding ]; # 0..1 Resource version
  fhir:PaymentNotice.originalRuleset [ Coding ]; # 0..1 Original version
  fhir:PaymentNotice.created [ dateTime ]; # 0..1 Creation date
  # PaymentNotice.target[x] : 0..1 Insurer or Regulatory body. One of these 2
    fhir:PaymentNotice.targetIdentifier [ Identifier ]
    fhir:PaymentNotice.targetReference [ Reference(Organization) ]
  # PaymentNotice.provider[x] : 0..1 Responsible practitioner. One of these 2
    fhir:PaymentNotice.providerIdentifier [ Identifier ]
    fhir:PaymentNotice.providerReference [ Reference(Practitioner) ]
  # PaymentNotice.organization[x] : 0..1 Responsible organization. One of these 2
    fhir:PaymentNotice.organizationIdentifier [ Identifier ]
    fhir:PaymentNotice.organizationReference [ Reference(Organization) ]
  # PaymentNotice.request[x] : 0..1 Request reference. One of these 2
    fhir:PaymentNotice.requestIdentifier [ Identifier ]
    fhir:PaymentNotice.requestReference [ Reference(Any) ]
  # PaymentNotice.response[x] : 0..1 Response reference. One of these 2
    fhir:PaymentNotice.responseIdentifier [ Identifier ]
    fhir:PaymentNotice.responseReference [ Reference(Any) ]
  fhir:PaymentNotice.paymentStatus [ Coding ]; # 1..1 Status of the payment
  fhir:PaymentNotice.statusDate [ date ]; # 0..1 Payment or clearing date
]

Changes since DSTU2

PaymentNotice
PaymentNotice.status added
PaymentNotice.target[x] Renamed from target to target[x]
Add Identifier
PaymentNotice.provider[x] Renamed from provider to provider[x]
Add Identifier
PaymentNotice.organization[x] Renamed from organization to organization[x]
Add Identifier
PaymentNotice.request[x] Renamed from request to request[x]
Add Identifier
PaymentNotice.response[x] Renamed from response to response[x]
Add Identifier
PaymentNotice.statusDate added

See the Full Difference for further information

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 . status ?! Σ 0..1 1..1 Coding code Resource version active | cancelled | draft | entered-in-error
Ruleset Codes ( Example PaymentNoticeStatus ( Required )
. . originalRuleset . ruleset 0..1 Coding Resource version
Σ 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 0..1 Identifier
. . . . targetReference Reference ( Organization )
. . provider . provider[x] 0..1 Responsible practitioner
.... providerIdentifier 0..1 Identifier
. . . . providerReference Reference ( Practitioner )
. . organization . organization[x] 0..1 Responsible organization
.... organizationIdentifier 0..1 Identifier
. . . . organizationReference Reference ( Organization )
. . request . request[x] 0..1 Request reference
.... requestIdentifier 0..1 Identifier
.... requestReference Reference ( Any )
. . response . response[x] 0..1 Response reference
.... responseIdentifier 0..1 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 ( Legend )

PaymentNotice ( ( DomainResource ) The Response business identifier The notice business identifier identifier : : Identifier [0..*] [0..*] The status of the resource instance (this element modifies the meaning of other elements) status : code [1..1] « A code specifying the state of the resource instance. (Strength=Required) PaymentNoticeStatus ! » 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 for which payment is being made request request[x] : Type [0..1] « Identifier : | Reference [0..1] « ( Any » ) » Reference of response to resource to reverse Reference of response to resource for which payment is being made 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>
 <</ruleset>
 <</originalRuleset>
 <
 <</target>
 <</provider>
 <</organization>
 <</request>
 <</response>
 <</paymentStatus>

 <identifier><!-- 0..* Identifier Business Identifier --></identifier>
 <status value="[code]"/><!-- 1..1 active | cancelled | draft | entered-in-error -->
 <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 JSON Template { "resourceType" : "", 

{doco
  "resourceType" : "PaymentNotice",

  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "

  "identifier" : [{ Identifier }], // Business Identifier
  "status" : "<code>", // R!  active | cancelled | draft | entered-in-error
  "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:

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 ]; # 1..1 active | cancelled | draft | entered-in-error
  fhir:PaymentNotice.ruleset [ Coding ]; # 0..1 Resource version
  fhir:PaymentNotice.originalRuleset [ Coding ]; # 0..1 Original version
  fhir:PaymentNotice.created [ dateTime ]; # 0..1 Creation date
  # PaymentNotice.target[x] : 0..1 Insurer or Regulatory body. One of these 2
    fhir:PaymentNotice.targetIdentifier [ Identifier ]
    fhir:PaymentNotice.targetReference [ Reference(Organization) ]
  # PaymentNotice.provider[x] : 0..1 Responsible practitioner. One of these 2
    fhir:PaymentNotice.providerIdentifier [ Identifier ]
    fhir:PaymentNotice.providerReference [ Reference(Practitioner) ]
  # PaymentNotice.organization[x] : 0..1 Responsible organization. One of these 2
    fhir:PaymentNotice.organizationIdentifier [ Identifier ]
    fhir:PaymentNotice.organizationReference [ Reference(Organization) ]
  # PaymentNotice.request[x] : 0..1 Request reference. One of these 2
    fhir:PaymentNotice.requestIdentifier [ Identifier ]
    fhir:PaymentNotice.requestReference [ Reference(Any) ]
  # PaymentNotice.response[x] : 0..1 Response reference. One of these 2
    fhir:PaymentNotice.responseIdentifier [ Identifier ]
    fhir:PaymentNotice.responseReference [ Reference(Any) ]
  fhir:PaymentNotice.paymentStatus [ Coding ]; # 1..1 Status of the payment
  fhir:PaymentNotice.statusDate [ date ]; # 0..1 Payment or clearing date
]

Changes since DSTU2

PaymentNotice
PaymentNotice.status added
PaymentNotice.target[x] Renamed from target to target[x]
Add Identifier
PaymentNotice.provider[x] Renamed from provider to provider[x]
Add Identifier
PaymentNotice.organization[x] Renamed from organization to organization[x]
Add Identifier
PaymentNotice.request[x] Renamed from request to request[x]
Add Identifier
PaymentNotice.response[x] Renamed from response to response[x]
Add Identifier
PaymentNotice.statusDate added

See the Full Difference for further information

 

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

7.9.2.1 Terminology Bindings 13.9.2.1 Terminology Bindings

PaymentNotice.paymentStatus
Path Definition Type Reference
PaymentNotice.status A code specifying the state of the resource instance. Required PaymentNoticeStatus
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 The payment conveyance status codes The payment conveyance status codes Example Payment Status Codes Payment Status Codes

7.9.3 Search Parameters 13.9.3 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
organization-identifier token | Version History The organization who generated this resource PaymentNotice.organizationIdentifier
organization-reference reference | Table of Contents The organization who generated this resource PaymentNotice.organizationReference
( Organization | Compare to DSTU1 )
payment-status token | The type of payment notice PaymentNotice.paymentStatus
provider-identifier token | Propose a change The reference to the provider PaymentNotice.providerIdentifier
provider-reference 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){ } } });
request-identifier token The Claim PaymentNotice.requestIdentifier
request-reference reference The Claim PaymentNotice.requestReference
(Any)
response-identifier token The ClaimResponse PaymentNotice.responseIdentifier
response-reference reference The ClaimResponse PaymentNotice.responseReference
(Any)
statusdate date The date of the payment action PaymentNotice.statusDate