charge items

Create Charge Item

post
/organizations/{organizationId}/fhir/4/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/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*This is a ChargeItem resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Identifiers assigned to this event performer or other systems.
definitionUriarray(uri)References the (external) source of pricing information, rules of application for the code this ChargeItem uses.
definitionCanonicalarray(canonical)References the source of pricing information, rules of application for the code this ChargeItem uses.
statusplanned|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.
performerarray(ChargeItem_Performer)Indicates who or what performed or participated in the charged service.
performingOrganizationReferenceThe organization requesting the service.
requestingOrganizationReferenceThe organization performing the service.
costCenterReferenceThe financial cost center permits the tracking of charge attribution.
quantityQuantityQuantity of which the charge item has been serviced.
bodysitearray(CodeableConcept)The anatomical location where the related service has been applied.
factorOverridedecimalFactor 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.
enteredDatedateTimeDate 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.
productReferenceReferenceIdentifies the device, food, drug or other product being charged either by type code or reference to an instance.
productCodeableConceptCodeableConceptIdentifies the device, food, drug or other product being charged either by type code or reference to an instance.
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 this charge.

Response

Patch Charge Item

patch
/organizations/{organizationId}/fhir/4/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*This is a ChargeItem resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Identifiers assigned to this event performer or other systems.
definitionUriarray(uri)References the (external) source of pricing information, rules of application for the code this ChargeItem uses.
definitionCanonicalarray(canonical)References the source of pricing information, rules of application for the code this ChargeItem uses.
statusplanned|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.
performerarray(ChargeItem_Performer)Indicates who or what performed or participated in the charged service.
performingOrganizationReferenceThe organization requesting the service.
requestingOrganizationReferenceThe organization performing the service.
costCenterReferenceThe financial cost center permits the tracking of charge attribution.
quantityQuantityQuantity of which the charge item has been serviced.
bodysitearray(CodeableConcept)The anatomical location where the related service has been applied.
factorOverridedecimalFactor 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.
enteredDatedateTimeDate 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.
productReferenceReferenceIdentifies the device, food, drug or other product being charged either by type code or reference to an instance.
productCodeableConceptCodeableConceptIdentifies the device, food, drug or other product being charged either by type code or reference to an instance.
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 this charge.

Response

Read Charge Item

get
/organizations/{organizationId}/fhir/4/ChargeItem/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Charge Item

get
/organizations/{organizationId}/fhir/4/ChargeItem/{resourceId}/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/ChargeItem/{resourceId}/_history/{versionId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Charge Item

delete
/organizations/{organizationId}/fhir/4/ChargeItem/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Charge Item

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

Request

Headers

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

Query params

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

Params

organizationId*string|stringid|slug

Response

Search History Charge Item

get
/organizations/{organizationId}/fhir/4/ChargeItem/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/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
patientstring
performer-actorstring
performer-functionstring
performing-organizationstring
price-overridestring
quantitystring
requesting-organizationstring
servicestring
subjectstring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a ChargeItem resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Identifiers assigned to this event performer or other systems.
definitionUriarray(uri)References the (external) source of pricing information, rules of application for the code this ChargeItem uses.
definitionCanonicalarray(canonical)References the source of pricing information, rules of application for the code this ChargeItem uses.
statusplanned|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.
performerarray(ChargeItem_Performer)Indicates who or what performed or participated in the charged service.
performingOrganizationReferenceThe organization requesting the service.
requestingOrganizationReferenceThe organization performing the service.
costCenterReferenceThe financial cost center permits the tracking of charge attribution.
quantityQuantityQuantity of which the charge item has been serviced.
bodysitearray(CodeableConcept)The anatomical location where the related service has been applied.
factorOverridedecimalFactor 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.
enteredDatedateTimeDate 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.
productReferenceReferenceIdentifies the device, food, drug or other product being charged either by type code or reference to an instance.
productCodeableConceptCodeableConceptIdentifies the device, food, drug or other product being charged either by type code or reference to an instance.
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 this charge.

Response

Update Charge Item

put
/organizations/{organizationId}/fhir/4/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|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a ChargeItem resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Identifiers assigned to this event performer or other systems.
definitionUriarray(uri)References the (external) source of pricing information, rules of application for the code this ChargeItem uses.
definitionCanonicalarray(canonical)References the source of pricing information, rules of application for the code this ChargeItem uses.
statusplanned|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.
performerarray(ChargeItem_Performer)Indicates who or what performed or participated in the charged service.
performingOrganizationReferenceThe organization requesting the service.
requestingOrganizationReferenceThe organization performing the service.
costCenterReferenceThe financial cost center permits the tracking of charge attribution.
quantityQuantityQuantity of which the charge item has been serviced.
bodysitearray(CodeableConcept)The anatomical location where the related service has been applied.
factorOverridedecimalFactor 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.
enteredDatedateTimeDate 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.
productReferenceReferenceIdentifies the device, food, drug or other product being charged either by type code or reference to an instance.
productCodeableConceptCodeableConceptIdentifies the device, food, drug or other product being charged either by type code or reference to an instance.
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 this charge.

Response