charge items

Create Charge Item

post

/organizations/{organizationId}/fhir/3/ChargeItem

The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.

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*	string	ChargeItem	This is a ChargeItem resource
identifier	Identifier		Identifiers assigned to this event performer or other systems.
definition	array()		References the source of pricing information, rules of application for the code this ChargeItem uses.
status	string	planned\|billable\|not-billable\|aborted\|billed\|entered-in-error\|unknown	The current state of the ChargeItem.
partOf	array(Reference)		ChargeItems can be grouped to larger ChargeItems covering the whole set.
code*	CodeableConcept		A code that identifies the charge, like a billing code.
subject*	Reference		The individual or set of individuals the action is being or was performed on.
context	Reference		The encounter or episode of care that establishes the context for this event.
occurrenceDateTime	string		Date/time(s) or duration when the charged service was applied.
occurrencePeriod	Period		Date/time(s) or duration when the charged service was applied.
occurrenceTiming	Timing		Date/time(s) or duration when the charged service was applied.
participant	array(ChargeItem_Participant)		Indicates who or what performed or participated in the charged service.
performingOrganization	Reference		The organization requesting the service.
requestingOrganization	Reference		The organization performing the service.
quantity	Quantity		Quantity of which the charge item has been serviced.
bodysite	array(CodeableConcept)		The anatomical location where the related service has been applied.
factorOverride	number		Factor overriding the factor determined by the rules associated with the code.
priceOverride	Money		Total price of the charge overriding the list price associated with the code.
overrideReason	string		If the list price or the rule based factor associated with the code is overridden, this attribute can capture a text to indicate the reason for this action.
enterer	Reference		The device, practitioner, etc. who entered the charge item.
enteredDate	string		Date the charge item was entered.
reason	array(CodeableConcept)		Describes why the event occurred in coded or textual form.
service	array(Reference)		Indicated the rendered service that caused this charge.
account	array(Reference)		Account into which this ChargeItems belongs.
note	array(Annotation)		Comments made about the event by the performer, subject or other participants.
supportingInformation	array(Reference)		Further information supporting the this charge.

Response

201 400 401 404

Patch Charge Item

patch

/organizations/{organizationId}/fhir/3/ChargeItem/{resourceId}

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*	string	ChargeItem	This is a ChargeItem resource
identifier	Identifier		Identifiers assigned to this event performer or other systems.
definition	array()		References the source of pricing information, rules of application for the code this ChargeItem uses.
status	string	planned\|billable\|not-billable\|aborted\|billed\|entered-in-error\|unknown	The current state of the ChargeItem.
partOf	array(Reference)		ChargeItems can be grouped to larger ChargeItems covering the whole set.
code*	CodeableConcept		A code that identifies the charge, like a billing code.
subject*	Reference		The individual or set of individuals the action is being or was performed on.
context	Reference		The encounter or episode of care that establishes the context for this event.
occurrenceDateTime	string		Date/time(s) or duration when the charged service was applied.
occurrencePeriod	Period		Date/time(s) or duration when the charged service was applied.
occurrenceTiming	Timing		Date/time(s) or duration when the charged service was applied.
participant	array(ChargeItem_Participant)		Indicates who or what performed or participated in the charged service.
performingOrganization	Reference		The organization requesting the service.
requestingOrganization	Reference		The organization performing the service.
quantity	Quantity		Quantity of which the charge item has been serviced.
bodysite	array(CodeableConcept)		The anatomical location where the related service has been applied.
factorOverride	number		Factor overriding the factor determined by the rules associated with the code.
priceOverride	Money		Total price of the charge overriding the list price associated with the code.
overrideReason	string		If the list price or the rule based factor associated with the code is overridden, this attribute can capture a text to indicate the reason for this action.
enterer	Reference		The device, practitioner, etc. who entered the charge item.
enteredDate	string		Date the charge item was entered.
reason	array(CodeableConcept)		Describes why the event occurred in coded or textual form.
service	array(Reference)		Indicated the rendered service that caused this charge.
account	array(Reference)		Account into which this ChargeItems belongs.
note	array(Annotation)		Comments made about the event by the performer, subject or other participants.
supportingInformation	array(Reference)		Further information supporting the this charge.

Response

200 201 400 401 404 409

Read Charge Item

get

/organizations/{organizationId}/fhir/3/ChargeItem/{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 Charge Item

get

/organizations/{organizationId}/fhir/3/ChargeItem/{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 Charge Item

get

/organizations/{organizationId}/fhir/3/ChargeItem/{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 Charge Item

delete

/organizations/{organizationId}/fhir/3/ChargeItem/{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 204 400 401 404 409

Search Get Charge Item

get

/organizations/{organizationId}/fhir/3/ChargeItem

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
account	string
code	string
context	string
entered-date	string
enterer	string
factor-override	string
identifier	string
occurrence	string
participant-actor	string
participant-role	string
patient	string
performing-organization	string
price-override	string
quantity	string
requesting-organization	string
service	string
subject	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Charge Item

get

/organizations/{organizationId}/fhir/3/ChargeItem/_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 Charge Item

post

/organizations/{organizationId}/fhir/3/ChargeItem/_search

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
account	string
code	string
context	string
entered-date	string
enterer	string
factor-override	string
identifier	string
occurrence	string
participant-actor	string
participant-role	string
patient	string
performing-organization	string
price-override	string
quantity	string
requesting-organization	string
service	string
subject	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	ChargeItem	This is a ChargeItem resource
identifier	Identifier		Identifiers assigned to this event performer or other systems.
definition	array()		References the source of pricing information, rules of application for the code this ChargeItem uses.
status	string	planned\|billable\|not-billable\|aborted\|billed\|entered-in-error\|unknown	The current state of the ChargeItem.
partOf	array(Reference)		ChargeItems can be grouped to larger ChargeItems covering the whole set.
code*	CodeableConcept		A code that identifies the charge, like a billing code.
subject*	Reference		The individual or set of individuals the action is being or was performed on.
context	Reference		The encounter or episode of care that establishes the context for this event.
occurrenceDateTime	string		Date/time(s) or duration when the charged service was applied.
occurrencePeriod	Period		Date/time(s) or duration when the charged service was applied.
occurrenceTiming	Timing		Date/time(s) or duration when the charged service was applied.
participant	array(ChargeItem_Participant)		Indicates who or what performed or participated in the charged service.
performingOrganization	Reference		The organization requesting the service.
requestingOrganization	Reference		The organization performing the service.
quantity	Quantity		Quantity of which the charge item has been serviced.
bodysite	array(CodeableConcept)		The anatomical location where the related service has been applied.
factorOverride	number		Factor overriding the factor determined by the rules associated with the code.
priceOverride	Money		Total price of the charge overriding the list price associated with the code.
overrideReason	string		If the list price or the rule based factor associated with the code is overridden, this attribute can capture a text to indicate the reason for this action.
enterer	Reference		The device, practitioner, etc. who entered the charge item.
enteredDate	string		Date the charge item was entered.
reason	array(CodeableConcept)		Describes why the event occurred in coded or textual form.
service	array(Reference)		Indicated the rendered service that caused this charge.
account	array(Reference)		Account into which this ChargeItems belongs.
note	array(Annotation)		Comments made about the event by the performer, subject or other participants.
supportingInformation	array(Reference)		Further information supporting the this charge.

Response

200 401 404

Update Charge Item

put

/organizations/{organizationId}/fhir/3/ChargeItem/{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*

Body


resourceType*	string	ChargeItem	This is a ChargeItem resource
identifier	Identifier		Identifiers assigned to this event performer or other systems.
definition	array()		References the source of pricing information, rules of application for the code this ChargeItem uses.
status	string	planned\|billable\|not-billable\|aborted\|billed\|entered-in-error\|unknown	The current state of the ChargeItem.
partOf	array(Reference)		ChargeItems can be grouped to larger ChargeItems covering the whole set.
code*	CodeableConcept		A code that identifies the charge, like a billing code.
subject*	Reference		The individual or set of individuals the action is being or was performed on.
context	Reference		The encounter or episode of care that establishes the context for this event.
occurrenceDateTime	string		Date/time(s) or duration when the charged service was applied.
occurrencePeriod	Period		Date/time(s) or duration when the charged service was applied.
occurrenceTiming	Timing		Date/time(s) or duration when the charged service was applied.
participant	array(ChargeItem_Participant)		Indicates who or what performed or participated in the charged service.
performingOrganization	Reference		The organization requesting the service.
requestingOrganization	Reference		The organization performing the service.
quantity	Quantity		Quantity of which the charge item has been serviced.
bodysite	array(CodeableConcept)		The anatomical location where the related service has been applied.
factorOverride	number		Factor overriding the factor determined by the rules associated with the code.
priceOverride	Money		Total price of the charge overriding the list price associated with the code.
overrideReason	string		If the list price or the rule based factor associated with the code is overridden, this attribute can capture a text to indicate the reason for this action.
enterer	Reference		The device, practitioner, etc. who entered the charge item.
enteredDate	string		Date the charge item was entered.
reason	array(CodeableConcept)		Describes why the event occurred in coded or textual form.
service	array(Reference)		Indicated the rendered service that caused this charge.
account	array(Reference)		Account into which this ChargeItems belongs.
note	array(Annotation)		Comments made about the event by the performer, subject or other participants.
supportingInformation	array(Reference)		Further information supporting the this charge.

Response

200 201 400 401 404 409