payment notices

Create Payment Notice

post
/organizations/{organizationId}/fhir/3/PaymentNotice

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringPaymentNoticeThis is a PaymentNotice resource
identifierarray(Identifier)The notice business identifier.
statusstringThe status of the resource instance.
requestReferenceReference of resource for which payment is being made.
responseReferenceReference of response to resource for which payment is being made.
statusDatestringThe date when the above payment action occurrred.
createdstringThe date when this resource was created.
targetReferenceThe Insurer who is target of the request.
providerReferenceThe practitioner who is responsible for the services rendered to the patient.
organizationReferenceThe organization which is responsible for the services rendered to the patient.
paymentStatusCodeableConceptThe payment status, typically paid: payment sent, cleared: payment received.

Response

Patch Payment Notice

patch
/organizations/{organizationId}/fhir/3/PaymentNotice/{resourceId}

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

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringPaymentNoticeThis is a PaymentNotice resource
identifierarray(Identifier)The notice business identifier.
statusstringThe status of the resource instance.
requestReferenceReference of resource for which payment is being made.
responseReferenceReference of response to resource for which payment is being made.
statusDatestringThe date when the above payment action occurrred.
createdstringThe date when this resource was created.
targetReferenceThe Insurer who is target of the request.
providerReferenceThe practitioner who is responsible for the services rendered to the patient.
organizationReferenceThe organization which is responsible for the services rendered to the patient.
paymentStatusCodeableConceptThe payment status, typically paid: payment sent, cleared: payment received.

Response

Read Payment Notice

get
/organizations/{organizationId}/fhir/3/PaymentNotice/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Payment Notice

get
/organizations/{organizationId}/fhir/3/PaymentNotice/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Payment Notice

get
/organizations/{organizationId}/fhir/3/PaymentNotice/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Payment Notice

delete
/organizations/{organizationId}/fhir/3/PaymentNotice/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Payment Notice

get
/organizations/{organizationId}/fhir/3/PaymentNotice

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
createdstring
identifierstring
organizationstring
payment-statusstring
providerstring
requeststring
responsestring
statusdatestring

Params

organizationId*string|stringid|slug

Response

Search History Payment Notice

get
/organizations/{organizationId}/fhir/3/PaymentNotice/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Payment Notice

post
/organizations/{organizationId}/fhir/3/PaymentNotice/_search

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

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
createdstring
identifierstring
organizationstring
payment-statusstring
providerstring
requeststring
responsestring
statusdatestring

Params

organizationId*string|stringid|slug

Body

resourceType*stringPaymentNoticeThis is a PaymentNotice resource
identifierarray(Identifier)The notice business identifier.
statusstringThe status of the resource instance.
requestReferenceReference of resource for which payment is being made.
responseReferenceReference of response to resource for which payment is being made.
statusDatestringThe date when the above payment action occurrred.
createdstringThe date when this resource was created.
targetReferenceThe Insurer who is target of the request.
providerReferenceThe practitioner who is responsible for the services rendered to the patient.
organizationReferenceThe organization which is responsible for the services rendered to the patient.
paymentStatusCodeableConceptThe payment status, typically paid: payment sent, cleared: payment received.

Response

Update Payment Notice

put
/organizations/{organizationId}/fhir/3/PaymentNotice/{resourceId}

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringPaymentNoticeThis is a PaymentNotice resource
identifierarray(Identifier)The notice business identifier.
statusstringThe status of the resource instance.
requestReferenceReference of resource for which payment is being made.
responseReferenceReference of response to resource for which payment is being made.
statusDatestringThe date when the above payment action occurrred.
createdstringThe date when this resource was created.
targetReferenceThe Insurer who is target of the request.
providerReferenceThe practitioner who is responsible for the services rendered to the patient.
organizationReferenceThe organization which is responsible for the services rendered to the patient.
paymentStatusCodeableConceptThe payment status, typically paid: payment sent, cleared: payment received.

Response