Skip to main content

PaymentNotice

Trial Use 2 Financial

This resource provides the status of the payment for goods and services rendered, and the request and response resource references.

Endpoints​

alphahttps://api.dev.ovok.com/fhir/R4/PaymentNotice
InteractionMethodPath
ReadGET/fhir/R4/PaymentNotice/[id]
VreadGET/fhir/R4/PaymentNotice/[id]/_history/[vid]
UpdatePUT/fhir/R4/PaymentNotice/[id]
PatchPATCH/fhir/R4/PaymentNotice/[id]
DeleteDELETE/fhir/R4/PaymentNotice/[id]
CreatePOST/fhir/R4/PaymentNotice
SearchGET/fhir/R4/PaymentNotice
HistoryGET/fhir/R4/PaymentNotice/[id]/_history

Top-level elements​

ElementType(s)CardinalityDescription
identifierIdentifier0..*Business Identifier for the payment noctice
statuscode1..1active | cancelled | draft | entered-in-error modifier
requestReference0..1Request reference
responseReference0..1Response reference
createddateTime1..1Creation date
providerReference0..1Responsible practitioner
paymentReference1..1Payment reference
paymentDatedate0..1Payment or clearing date
payeeReference0..1Party being paid
recipientReference1..1Party being notified
amountMoney1..1Monetary amount of the payment
paymentStatusCodeableConcept0..1Issued or cleared Status of the payment

Resource-specific search parameters​

ParameterTypeDescription
_compartmentstring
_countstringhttps://www.hl7.org/fhir/search.html#_count
_elementsstringhttps://www.hl7.org/fhir/search.html#_elements
_idstring
_lastUpdatedstring
_profilestring
_securitystring
_sortstringhttps://www.hl7.org/fhir/search.html#_sort
_sourcestring
_summarystringhttps://www.hl7.org/fhir/search.html#_summary
_tagstring
_totalstringhttps://www.hl7.org/fhir/search.html#_total
createdstringhttp://hl7.org/fhir/SearchParameter/PaymentNotice-created
identifierstringhttp://hl7.org/fhir/SearchParameter/PaymentNotice-identifier
payment-statusstringhttp://hl7.org/fhir/SearchParameter/PaymentNotice-payment-status
providerstringhttp://hl7.org/fhir/SearchParameter/PaymentNotice-provider
requeststringhttp://hl7.org/fhir/SearchParameter/PaymentNotice-request
responsestringhttp://hl7.org/fhir/SearchParameter/PaymentNotice-response
statusstringhttp://hl7.org/fhir/SearchParameter/PaymentNotice-status

Reference​

  • Official FHIR R4 spec: PaymentNotice
  • Maturity: Trial Use 2 (FMM 2).