R4 Ballot #1 (Mixed Normative/Trial use)
FinancialThis page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4
| Financial Management Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Practitioner |
This is a representation of the json schema for PaymentReconciliation, 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/PaymentReconciliation",
"$ref": "#/definitions/PaymentReconciliation",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"PaymentReconciliation": {
"description": "This resource provides payment details and claim references supporting a bulk payment.",
"properties": {
"resourceType": {
"description": "This is a PaymentReconciliation resource",
"const": "PaymentReconciliation"
},
"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, and nor can they have their own independent transaction scope.",
"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 manageable, 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. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"identifier": {
"description": "The Response business identifier.",
"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"
},
"period": {
"description": "The period of time for which payments have been gathered into this bulk payment for settlement.",
"$ref": "Period.schema.json#/definitions/Period"
},
"created": {
"description": "The date when the enclosed suite of services were performed or completed.",
"$ref": "#/definitions/dateTime"
},
"_created": {
"description": "Extensions for created",
"$ref": "Element.schema.json#/definitions/Element"
},
"organization": {
"description": "The Insurer who produced this adjudicated response.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"request": {
"description": "Original request resource reference.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"outcome": {
"description": "Transaction status: error, complete.",
"enum": [
"queued",
"complete",
"error",
"partial"
]
},
"_outcome": {
"description": "Extensions for outcome",
"$ref": "Element.schema.json#/definitions/Element"
},
"disposition": {
"description": "A description of the status of the adjudication.",
"$ref": "#/definitions/string"
},
"_disposition": {
"description": "Extensions for disposition",
"$ref": "Element.schema.json#/definitions/Element"
},
"requestProvider": {
"description": "The practitioner who is responsible for the services rendered to the patient.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"detail": {
"description": "List of individual settlement amounts and the corresponding transaction.",
"items": {
"$ref": "#/definitions/PaymentReconciliation_Detail"
},
"type": "array"
},
"form": {
"description": "The form to be used for printing the content.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"total": {
"description": "Total payment amount.",
"$ref": "Money.schema.json#/definitions/Money"
},
"processNote": {
"description": "Suite of notes.",
"items": {
"$ref": "#/definitions/PaymentReconciliation_ProcessNote"
},
"type": "array"
}
},
"additionalProperties": false,
"required": [
"resourceType"
]
},
"PaymentReconciliation_Detail": {
"description": "This resource provides payment details and claim references supporting a bulk payment.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, 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 element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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. Applications processing a resource are required to check for modifier extensions.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "Code to indicate the nature of the payment, adjustment, funds advance, etc.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"request": {
"description": "The claim or financial resource.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"response": {
"description": "The claim response resource.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"submitter": {
"description": "The Organization which submitted the claim or financial transaction.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"payee": {
"description": "The organization which is receiving the payment.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"date": {
"description": "The date of the invoice or financial resource.",
"$ref": "#/definitions/date"
},
"_date": {
"description": "Extensions for date",
"$ref": "Element.schema.json#/definitions/Element"
},
"amount": {
"description": "Amount paid for this detail.",
"$ref": "Money.schema.json#/definitions/Money"
}
},
"additionalProperties": false,
"required": [
"type"
]
},
"PaymentReconciliation_ProcessNote": {
"description": "This resource provides payment details and claim references supporting a bulk payment.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, 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 element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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. Applications processing a resource are required to check for modifier extensions.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "The note purpose: Print/Display.",
"enum": [
"display",
"print",
"printoper"
]
},
"_type": {
"description": "Extensions for type",
"$ref": "Element.schema.json#/definitions/Element"
},
"text": {
"description": "The note text.",
"$ref": "#/definitions/string"
},
"_text": {
"description": "Extensions for text",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"additionalProperties": false
}
}
}
®© HL7.org 2011+. FHIR Mixed Nomative/Trial Use Ballot (v3.3.0-13671) generated on Tue, Apr 3, 2018 12:17+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
|
Propose a change