PaymentNotice - FHIR Resource (stu3)


This PaymentNotice Resource uses the FHIR API standard for access and structure.

Validate an PaymentNotice FHIR Resource (stu3)



Resource Attributes

AttributeField is listTypeDescription
createdfalsedateTime Creation date
identifiertrueIdentifier Business Identifier
organizationfalseReference Responsible organization
paymentStatusfalseCodeableConcept Whether payment has been sent or cleared
providerfalseReference Responsible practitioner
requestfalseReference Request reference
responsefalseReference Response reference
statusfalsecode active | cancelled | draft | entered-in-error
statusDatefalsedate Payment or clearing date
targetfalseReference 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 the like so:

https://api.1up.health/fhir/stu3/PaymentNotice?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
createddatecreated
identifiertextidentifier
organizationreferenceorganization
payment-statustextpaymentStatus
providerreferenceprovider
requestreferencerequest
responsereferenceresponse
statusdatedatestatusDate