payment notices

Create Payment Notice

post

/organizations/{organizationId}/fhir/4/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*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug

Body


resourceType*		This is a PaymentNotice resource
id	id	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta	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.
implicitRules	uri	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.
language	code	The base language in which the resource is written.
text	Narrative	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.
contained	array(ResourceList)	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.
extension	array(Extension)	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.
modifierExtension	array(Extension)	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's descendants. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifier	array(Identifier)	A unique identifier assigned to this payment notice.
status	code	The status of the resource instance.
request	Reference	Reference of resource for which payment is being made.
response	Reference	Reference of response to resource for which payment is being made.
created	dateTime	The date when this resource was created.
provider	Reference	The practitioner who is responsible for the services rendered to the patient.
payment*	Reference	A reference to the payment which is the subject of this notice.
paymentDate	date	The date when the above payment action occurred.
payee	Reference	The party who will receive or has received payment that is the subject of this notification.
recipient*	Reference	The party who is notified of the payment status.
amount*	Money	The amount sent to the payee.
paymentStatus	CodeableConcept	A code indicating whether payment has been sent or cleared.

Response

200 400 401 404

Patch Payment Notice

patch

/organizations/{organizationId}/fhir/4/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*	string	application/json-patch+json	application/json-patch+json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*		This is a PaymentNotice resource
id	id	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta	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.
implicitRules	uri	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.
language	code	The base language in which the resource is written.
text	Narrative	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.
contained	array(ResourceList)	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.
extension	array(Extension)	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.
modifierExtension	array(Extension)	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's descendants. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifier	array(Identifier)	A unique identifier assigned to this payment notice.
status	code	The status of the resource instance.
request	Reference	Reference of resource for which payment is being made.
response	Reference	Reference of response to resource for which payment is being made.
created	dateTime	The date when this resource was created.
provider	Reference	The practitioner who is responsible for the services rendered to the patient.
payment*	Reference	A reference to the payment which is the subject of this notice.
paymentDate	date	The date when the above payment action occurred.
payee	Reference	The party who will receive or has received payment that is the subject of this notification.
recipient*	Reference	The party who is notified of the payment status.
amount*	Money	The amount sent to the payee.
paymentStatus	CodeableConcept	A code indicating whether payment has been sent or cleared.

Response

200 400 401 404 409

Read Payment Notice

get

/organizations/{organizationId}/fhir/4/PaymentNotice/{resourceId}

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read History Payment Notice

get

/organizations/{organizationId}/fhir/4/PaymentNotice/{resourceId}/_history

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read Version Payment Notice

get

/organizations/{organizationId}/fhir/4/PaymentNotice/{resourceId}/_history/{versionId}

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string	id\|slug
resourceId*
versionId*

Response

200 400 401 404

Remove Payment Notice

delete

/organizations/{organizationId}/fhir/4/PaymentNotice/{resourceId}

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 400 401 404 409

Search Get Payment Notice

get

/organizations/{organizationId}/fhir/4/PaymentNotice

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
created	string
identifier	string
payment-status	string
provider	string
request	string
response	string
status	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Payment Notice

get

/organizations/{organizationId}/fhir/4/PaymentNotice/_history

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search Post Payment Notice

post

/organizations/{organizationId}/fhir/4/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*	string	application/json\|application/x-www-form-urlencoded	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
created	string
identifier	string
payment-status	string
provider	string
request	string
response	string
status	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*		This is a PaymentNotice resource
id	id	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta	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.
implicitRules	uri	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.
language	code	The base language in which the resource is written.
text	Narrative	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.
contained	array(ResourceList)	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.
extension	array(Extension)	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.
modifierExtension	array(Extension)	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's descendants. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifier	array(Identifier)	A unique identifier assigned to this payment notice.
status	code	The status of the resource instance.
request	Reference	Reference of resource for which payment is being made.
response	Reference	Reference of response to resource for which payment is being made.
created	dateTime	The date when this resource was created.
provider	Reference	The practitioner who is responsible for the services rendered to the patient.
payment*	Reference	A reference to the payment which is the subject of this notice.
paymentDate	date	The date when the above payment action occurred.
payee	Reference	The party who will receive or has received payment that is the subject of this notification.
recipient*	Reference	The party who is notified of the payment status.
amount*	Money	The amount sent to the payee.
paymentStatus	CodeableConcept	A code indicating whether payment has been sent or cleared.

Response

200 401 404

Update Payment Notice

put

/organizations/{organizationId}/fhir/4/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*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*		This is a PaymentNotice resource
id	id	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta	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.
implicitRules	uri	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.
language	code	The base language in which the resource is written.
text	Narrative	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.
contained	array(ResourceList)	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.
extension	array(Extension)	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.
modifierExtension	array(Extension)	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's descendants. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifier	array(Identifier)	A unique identifier assigned to this payment notice.
status	code	The status of the resource instance.
request	Reference	Reference of resource for which payment is being made.
response	Reference	Reference of response to resource for which payment is being made.
created	dateTime	The date when this resource was created.
provider	Reference	The practitioner who is responsible for the services rendered to the patient.
payment*	Reference	A reference to the payment which is the subject of this notice.
paymentDate	date	The date when the above payment action occurred.
payee	Reference	The party who will receive or has received payment that is the subject of this notification.
recipient*	Reference	The party who is notified of the payment status.
amount*	Money	The amount sent to the payee.
paymentStatus	CodeableConcept	A code indicating whether payment has been sent or cleared.

Response

200 400 401 404 409