PaymentNotice - FHIR Resource (stu3)
This PaymentNotice Resource uses the
FHIR API standard for access and structure.
Validate an PaymentNotice FHIR Resource (stu3)
Resource Attributes
Attribute | Field is list | Type | Description |
---|
created | false | dateTime | # Creation date
|
identifier | true | Identifier | # Business Identifier
|
organization | false | Reference | # Responsible organization
|
paymentStatus | false | CodeableConcept | # Whether payment has been sent or cleared
|
provider | false | Reference | # Responsible practitioner
|
request | false | Reference | # Request reference
|
response | false | Reference | # Response reference
|
status | false | code | # active | cancelled | draft | entered-in-error
|
statusDate | false | date | # Payment or clearing date
|
target | false | Reference | # Insurer or Regulatory body
|
PaymentNotice Example
{
"status": "active",
"target": {
"identifier": {
"system": "http://regulators.gov",
"value": "AB123"
}
},
"created": "2014-08-16",
"resourceType": "PaymentNotice",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">A human-readable rendering of the PaymentNotice</div>"
},
"request": {
"reference": "http://benefitsinc.com/fhir/claim/12345"
},
"paymentStatus": {
"coding": [
{
"code": "paid",
"system": "http://hl7.org/fhir/paymentstatus"
}
]
},
"response": {
"reference": "http://benefitsinc.com/fhir/claimresponse/CR12345"
},
"provider": {
"identifier": {
"system": "http://npid.org/provider",
"value": "PR957857"
}
},
"statusDate": "2014-08-15",
"organization": {
"reference": "Organization/1"
},
"identifier": [
{
"system": "http://benefitsinc.com/paymentnotice",
"value": "776543"
}
],
"id": "77654"
}
PaymentNotice Structure
{
"resourceType" : "PaymentNotice",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Business Identifier
"status" : "<code>", // active | cancelled | draft | entered-in-error
"request" : { Reference(Any) }, // Request reference
"response" : { Reference(Any) }, // Response reference
"statusDate" : "<date>", // Payment or clearing date
"created" : "<dateTime>", // Creation date
"target" : { Reference(Organization) }, // Insurer or Regulatory body
"provider" : { Reference(Practitioner) }, // Responsible practitioner
"organization" : { Reference(Organization) }, // Responsible organization
"paymentStatus" : { CodeableConcept } // Whether payment has been sent or cleared
}
PaymentNotice Search Parameters
The following search parameters can be used to query PaymentNotice resources. Just submit them like so:
https://api.1up.health/fhir/stu3/PaymentNotice?query-param=queryvalue
Search Parameter | Field Type | Resource Fields Searched |
---|
created | date | created |
identifier | text | identifier |
organization | reference | organization |
payment-status | text | paymentStatus |
provider | reference | provider |
request | reference | request |
response | reference | response |
statusdate | date | statusDate |