PaymentNotice - FHIR Resource (stu3)

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

Validate an PaymentNotice FHIR Resource (stu3)

PaymentNotice Attributes

AttributeField is listTypeDescription

Description: active | cancelled | draft | entered-in-error

FHIR Version: stu3

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"status": "active"

Learn more about the (PaymentNotice) status FHIR attribute

Description: Insurer or Regulatory body

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"target": {
  "identifier": {
    "system": "http://regulators.gov",
    "value": "AB123"
  }
}

Learn more about the (PaymentNotice) target FHIR attribute

Description: Creation date

FHIR Version: stu3

Attribute Type : dateTime

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"created": "2014-08-16"

Learn more about the (PaymentNotice) created FHIR attribute

Description: Request reference

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"request": {
  "reference": "http://benefitsinc.com/fhir/claim/12345"
}

Learn more about the (PaymentNotice) request FHIR attribute

Description: Whether payment has been sent or cleared

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"paymentStatus": {
  "coding": [
    {
      "code": "paid",
      "system": "http://hl7.org/fhir/paymentstatus"
    }
  ]
}

Learn more about the (PaymentNotice) paymentStatus FHIR attribute

Description: Responsible practitioner

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"provider": {
  "identifier": {
    "system": "http://npid.org/provider",
    "value": "PR957857"
  }
}

Learn more about the (PaymentNotice) provider FHIR attribute

Description: Payment or clearing date

FHIR Version: stu3

Attribute Type : date

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"statusDate": "2014-08-15"

Learn more about the (PaymentNotice) statusDate FHIR attribute

Description: Responsible organization

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"organization": {
  "reference": "Organization/1"
}

Learn more about the (PaymentNotice) organization FHIR attribute

Description: Business Identifier

FHIR Version: stu3

Attribute Type : Identifier

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"identifier": [
  {
    "system": "http://benefitsinc.com/paymentnotice",
    "value": "776543"
  }
]

Learn more about the (PaymentNotice) identifier FHIR attribute

Description: Response reference

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"response": {
  "reference": "http://benefitsinc.com/fhir/claimresponse/CR12345"
}

Learn more about the (PaymentNotice) response FHIR attribute

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`