This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

13.8.12 JSON Schema for PaymentNotice

Financial Management Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: Practitioner

This is a representation of the json schema for PaymentNotice, which is just a part of the full JSON Schema.

{
  "$schema": "http://json-schema.org/draft-06/schema#",
  "id": "http://hl7.org/fhir/json-schema/PaymentNotice",
  "$ref": "#/definitions/PaymentNotice",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "PaymentNotice": {
      "description": "This resource provides the status of the payment for goods and services rendered, and the request and response resource references.",
      "properties": {
        "resourceType": {
          "description": "This is a PaymentNotice resource",
          "const": "PaymentNotice"
        },
        "id": {
          "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
          "$ref": "id.schema.json#/definitions/id"
        },
        "meta": {
          "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
          "$ref": "Meta.schema.json#/definitions/Meta"
        },
        "implicitRules": {
          "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
          "$ref": "#/definitions/uri"
        },
        "_implicitRules": {
          "description": "Extensions for implicitRules",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "language": {
          "description": "The base language in which the resource is written.",
          "$ref": "#/definitions/code"
        },
        "_language": {
          "description": "Extensions for language",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "text": {
          "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
          "$ref": "Narrative.schema.json#/definitions/Narrative"
        },
        "contained": {
          "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
          "items": {
            "$ref": "ResourceList.schema.json#/definitions/ResourceList"
          },
          "type": "array"
        },
        "extension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "identifier": {
          "description": "A unique identifier assigned to this payment notice.",
          "items": {
            "$ref": "Identifier.schema.json#/definitions/Identifier"
          },
          "type": "array"
        },
        "status": {
          "description": "The status of the resource instance.",
          "$ref": "#/definitions/code"
        },
        "_status": {
          "description": "Extensions for status",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "request": {
          "description": "Reference of resource for which payment is being made.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "response": {
          "description": "Reference of response to resource for which payment is being made.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "created": {
          "description": "The date when this resource was created.",
          "$ref": "#/definitions/dateTime"
        },
        "_created": {
          "description": "Extensions for created",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "reporter": {
          "description": "The party who reports the payment notice.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "payment": {
          "description": "A reference to the payment which is the subject of this notice.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "paymentDate": {
          "description": "The date when the above payment action occurred.",
          "$ref": "#/definitions/date"
        },
        "_paymentDate": {
          "description": "Extensions for paymentDate",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "payee": {
          "description": "The party who will receive or has received payment that is the subject of this notification.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "recipient": {
          "description": "The party who is notified of the payment status.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "amount": {
          "description": "The amount sent to the payee.",
          "$ref": "Money.schema.json#/definitions/Money"
        },
        "paymentStatus": {
          "description": "A code indicating whether payment has been sent or cleared.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        }
      },
      "type": "object",
      "additionalProperties": false,
      "required": [
        "amount",
        "recipient",
        "resourceType"
      ]
    }
  }
}