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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringChargeItemThis is a ChargeItem resource
identifierIdentifierIdentifiers assigned to this event performer or other systems.
definitionarray()References the source of pricing information, rules of application for the code this ChargeItem uses.
statusstringplanned|billable|not-billable|aborted|billed|entered-in-error|unknownThe current state of the ChargeItem.
partOfarray(Reference)ChargeItems can be grouped to larger ChargeItems covering the whole set.
code*CodeableConceptA code that identifies the charge, like a billing code.
subject*ReferenceThe individual or set of individuals the action is being or was performed on.
contextReferenceThe encounter or episode of care that establishes the context for this event.
occurrenceDateTimestringDate/time(s) or duration when the charged service was applied.
occurrencePeriodPeriodDate/time(s) or duration when the charged service was applied.
occurrenceTimingTimingDate/time(s) or duration when the charged service was applied.
participantarray(ChargeItem_Participant)Indicates who or what performed or participated in the charged service.
performingOrganizationReferenceThe organization requesting the service.
requestingOrganizationReferenceThe organization performing the service.
quantityQuantityQuantity of which the charge item has been serviced.
bodysitearray(CodeableConcept)The anatomical location where the related service has been applied.
factorOverridenumberFactor overriding the factor determined by the rules associated with the code.
priceOverrideMoneyTotal price of the charge overriding the list price associated with the code.
overrideReasonstringIf 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.
entererReferenceThe device, practitioner, etc. who entered the charge item.
enteredDatestringDate the charge item was entered.
reasonarray(CodeableConcept)Describes why the event occurred in coded or textual form.
servicearray(Reference)Indicated the rendered service that caused this charge.
accountarray(Reference)Account into which this ChargeItems belongs.
notearray(Annotation)Comments made about the event by the performer, subject or other participants.
supportingInformationarray(Reference)Further information supporting the this charge.

Response

Patch Charge Item

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

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*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringChargeItemThis is a ChargeItem resource
identifierIdentifierIdentifiers assigned to this event performer or other systems.
definitionarray()References the source of pricing information, rules of application for the code this ChargeItem uses.
statusstringplanned|billable|not-billable|aborted|billed|entered-in-error|unknownThe current state of the ChargeItem.
partOfarray(Reference)ChargeItems can be grouped to larger ChargeItems covering the whole set.
code*CodeableConceptA code that identifies the charge, like a billing code.
subject*ReferenceThe individual or set of individuals the action is being or was performed on.
contextReferenceThe encounter or episode of care that establishes the context for this event.
occurrenceDateTimestringDate/time(s) or duration when the charged service was applied.
occurrencePeriodPeriodDate/time(s) or duration when the charged service was applied.
occurrenceTimingTimingDate/time(s) or duration when the charged service was applied.
participantarray(ChargeItem_Participant)Indicates who or what performed or participated in the charged service.
performingOrganizationReferenceThe organization requesting the service.
requestingOrganizationReferenceThe organization performing the service.
quantityQuantityQuantity of which the charge item has been serviced.
bodysitearray(CodeableConcept)The anatomical location where the related service has been applied.
factorOverridenumberFactor overriding the factor determined by the rules associated with the code.
priceOverrideMoneyTotal price of the charge overriding the list price associated with the code.
overrideReasonstringIf 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.
entererReferenceThe device, practitioner, etc. who entered the charge item.
enteredDatestringDate the charge item was entered.
reasonarray(CodeableConcept)Describes why the event occurred in coded or textual form.
servicearray(Reference)Indicated the rendered service that caused this charge.
accountarray(Reference)Account into which this ChargeItems belongs.
notearray(Annotation)Comments made about the event by the performer, subject or other participants.
supportingInformationarray(Reference)Further information supporting the this charge.

Response

Read Charge Item

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

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

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

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

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

Request

Headers

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

Query params

_idstring
_languagestring
accountstring
codestring
contextstring
entered-datestring
entererstring
factor-overridestring
identifierstring
occurrencestring
participant-actorstring
participant-rolestring
patientstring
performing-organizationstring
price-overridestring
quantitystring
requesting-organizationstring
servicestring
subjectstring

Params

organizationId*string|stringid|slug

Response

Search History Charge Item

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

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

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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
accountstring
codestring
contextstring
entered-datestring
entererstring
factor-overridestring
identifierstring
occurrencestring
participant-actorstring
participant-rolestring
patientstring
performing-organizationstring
price-overridestring
quantitystring
requesting-organizationstring
servicestring
subjectstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringChargeItemThis is a ChargeItem resource
identifierIdentifierIdentifiers assigned to this event performer or other systems.
definitionarray()References the source of pricing information, rules of application for the code this ChargeItem uses.
statusstringplanned|billable|not-billable|aborted|billed|entered-in-error|unknownThe current state of the ChargeItem.
partOfarray(Reference)ChargeItems can be grouped to larger ChargeItems covering the whole set.
code*CodeableConceptA code that identifies the charge, like a billing code.
subject*ReferenceThe individual or set of individuals the action is being or was performed on.
contextReferenceThe encounter or episode of care that establishes the context for this event.
occurrenceDateTimestringDate/time(s) or duration when the charged service was applied.
occurrencePeriodPeriodDate/time(s) or duration when the charged service was applied.
occurrenceTimingTimingDate/time(s) or duration when the charged service was applied.
participantarray(ChargeItem_Participant)Indicates who or what performed or participated in the charged service.
performingOrganizationReferenceThe organization requesting the service.
requestingOrganizationReferenceThe organization performing the service.
quantityQuantityQuantity of which the charge item has been serviced.
bodysitearray(CodeableConcept)The anatomical location where the related service has been applied.
factorOverridenumberFactor overriding the factor determined by the rules associated with the code.
priceOverrideMoneyTotal price of the charge overriding the list price associated with the code.
overrideReasonstringIf 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.
entererReferenceThe device, practitioner, etc. who entered the charge item.
enteredDatestringDate the charge item was entered.
reasonarray(CodeableConcept)Describes why the event occurred in coded or textual form.
servicearray(Reference)Indicated the rendered service that caused this charge.
accountarray(Reference)Account into which this ChargeItems belongs.
notearray(Annotation)Comments made about the event by the performer, subject or other participants.
supportingInformationarray(Reference)Further information supporting the this charge.

Response

Update Charge Item

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

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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringChargeItemThis is a ChargeItem resource
identifierIdentifierIdentifiers assigned to this event performer or other systems.
definitionarray()References the source of pricing information, rules of application for the code this ChargeItem uses.
statusstringplanned|billable|not-billable|aborted|billed|entered-in-error|unknownThe current state of the ChargeItem.
partOfarray(Reference)ChargeItems can be grouped to larger ChargeItems covering the whole set.
code*CodeableConceptA code that identifies the charge, like a billing code.
subject*ReferenceThe individual or set of individuals the action is being or was performed on.
contextReferenceThe encounter or episode of care that establishes the context for this event.
occurrenceDateTimestringDate/time(s) or duration when the charged service was applied.
occurrencePeriodPeriodDate/time(s) or duration when the charged service was applied.
occurrenceTimingTimingDate/time(s) or duration when the charged service was applied.
participantarray(ChargeItem_Participant)Indicates who or what performed or participated in the charged service.
performingOrganizationReferenceThe organization requesting the service.
requestingOrganizationReferenceThe organization performing the service.
quantityQuantityQuantity of which the charge item has been serviced.
bodysitearray(CodeableConcept)The anatomical location where the related service has been applied.
factorOverridenumberFactor overriding the factor determined by the rules associated with the code.
priceOverrideMoneyTotal price of the charge overriding the list price associated with the code.
overrideReasonstringIf 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.
entererReferenceThe device, practitioner, etc. who entered the charge item.
enteredDatestringDate the charge item was entered.
reasonarray(CodeableConcept)Describes why the event occurred in coded or textual form.
servicearray(Reference)Indicated the rendered service that caused this charge.
accountarray(Reference)Account into which this ChargeItems belongs.
notearray(Annotation)Comments made about the event by the performer, subject or other participants.
supportingInformationarray(Reference)Further information supporting the this charge.

Response