spark_auto_mapper_fhir.resources.charge_item
¶
Module Contents¶
Classes¶
ChargeItem |
- class spark_auto_mapper_fhir.resources.charge_item.ChargeItem(*, id_=None, meta=None, implicitRules=None, language=None, text=None, contained=None, extension=None, modifierExtension=None, identifier=None, definitionUri=None, definitionCanonical=None, status, partOf=None, code, subject, context=None, occurrenceDateTime=None, occurrencePeriod=None, occurrenceTiming=None, performer=None, performingOrganization=None, requestingOrganization=None, costCenter=None, quantity=None, bodysite=None, factorOverride=None, priceOverride=None, overrideReason=None, enterer=None, enteredDate=None, reason=None, service=None, productReference=None, productCodeableConcept=None, account=None, note=None, supportingInformation=None)¶
Bases:
spark_auto_mapper_fhir.base_types.fhir_resource_base.FhirResourceBase
ChargeItem chargeitem.xsd
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.
If the element is present, it must have either a @value, an @id, or extensions
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.
If the element is present, it must have either a @value, an @id, or extensions
- param id_
The logical id of the resource, as used in the URL for the resource. Once
- assigned, this value never changes.
- param 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.
- param implicitRules
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.
- param language
The base language in which the resource is written.
- param text
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.
- param contained
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.
- param 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.
- param modifierExtension
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).
- param identifier
Identifiers assigned to this event performer or other systems.
- param definitionUri
References the (external) source of pricing information, rules of application
- for the code this ChargeItem uses.
- param definitionCanonical
References the source of pricing information, rules of application for the
- code this ChargeItem uses.
- param status
The current state of the ChargeItem.
- param partOf
ChargeItems can be grouped to larger ChargeItems covering the whole set.
- param code
A code that identifies the charge, like a billing code.
- param subject
The individual or set of individuals the action is being or was performed on.
- param context
The encounter or episode of care that establishes the context for this event.
- param occurrenceDateTime
None
- param occurrencePeriod
None
- param occurrenceTiming
None
- param performer
Indicates who or what performed or participated in the charged service.
- param performingOrganization
The organization requesting the service.
- param requestingOrganization
The organization performing the service.
- param costCenter
The financial cost center permits the tracking of charge attribution.
- param quantity
Quantity of which the charge item has been serviced.
- param bodysite
The anatomical location where the related service has been applied.
- param factorOverride
Factor overriding the factor determined by the rules associated with the code.
- param priceOverride
Total price of the charge overriding the list price associated with the code.
- param overrideReason
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.
- param enterer
The device, practitioner, etc. who entered the charge item.
- param enteredDate
Date the charge item was entered.
- param reason
Describes why the event occurred in coded or textual form.
- param service
Indicated the rendered service that caused this charge.
- param productReference
None
- param productCodeableConcept
None
- param account
Account into which this ChargeItems belongs.
- param note
Comments made about the event by the performer, subject or other participants.
- param supportingInformation
Further information supporting this charge.
- Parameters
id_ (Optional[spark_auto_mapper_fhir.fhir_types.id.FhirId]) –
meta (Optional[spark_auto_mapper_fhir.complex_types.meta.Meta]) –
implicitRules (Optional[spark_auto_mapper_fhir.fhir_types.uri.FhirUri]) –
language (Optional[spark_auto_mapper_fhir.value_sets.common_languages.CommonLanguagesCode]) –
text (Optional[spark_auto_mapper_fhir.complex_types.narrative.Narrative]) –
contained (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.resource_container.ResourceContainer]]) –
extension (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.extensions.extension_base.ExtensionBase]]) –
modifierExtension (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.extensions.extension_base.ExtensionBase]]) –
identifier (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.identifier.Identifier]]) –
definitionUri (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.fhir_types.uri.FhirUri]]) –
definitionCanonical (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.fhir_types.canonical.FhirCanonical]]) –
status (spark_auto_mapper_fhir.value_sets.charge_item_status.ChargeItemStatusCode) –
partOf (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.reference.Reference[ChargeItem]]]) –
code (spark_auto_mapper_fhir.complex_types.codeable_concept.CodeableConcept[spark_auto_mapper_fhir.value_sets.charge_item_code.ChargeItemCodeCode]) –
subject (spark_auto_mapper_fhir.complex_types.reference.Reference[Union[spark_auto_mapper_fhir.resources.patient.Patient, spark_auto_mapper_fhir.resources.group.Group]]) –
context (Optional[spark_auto_mapper_fhir.complex_types.reference.Reference[Union[spark_auto_mapper_fhir.resources.encounter.Encounter, spark_auto_mapper_fhir.resources.episode_of_care.EpisodeOfCare]]]) –
occurrenceDateTime (Optional[spark_auto_mapper_fhir.fhir_types.date_time.FhirDateTime]) –
occurrencePeriod (Optional[spark_auto_mapper_fhir.complex_types.period.Period]) –
occurrenceTiming (Optional[spark_auto_mapper_fhir.backbone_elements.timing.Timing]) –
performer (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.backbone_elements.charge_item_performer.ChargeItemPerformer]]) –
performingOrganization (Optional[spark_auto_mapper_fhir.complex_types.reference.Reference[spark_auto_mapper_fhir.resources.organization.Organization]]) –
requestingOrganization (Optional[spark_auto_mapper_fhir.complex_types.reference.Reference[spark_auto_mapper_fhir.resources.organization.Organization]]) –
costCenter (Optional[spark_auto_mapper_fhir.complex_types.reference.Reference[spark_auto_mapper_fhir.resources.organization.Organization]]) –
quantity (Optional[spark_auto_mapper_fhir.complex_types.quantity.Quantity]) –
bodysite (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.codeable_concept.CodeableConcept[spark_auto_mapper_fhir.value_sets.snomedct_body_structures.SNOMEDCTBodyStructuresCode]]]) –
factorOverride (Optional[spark_auto_mapper_fhir.fhir_types.decimal.FhirDecimal]) –
priceOverride (Optional[spark_auto_mapper_fhir.complex_types.money.Money]) –
overrideReason (Optional[spark_auto_mapper_fhir.fhir_types.string.FhirString]) –
enterer (Optional[spark_auto_mapper_fhir.complex_types.reference.Reference[Union[spark_auto_mapper_fhir.resources.practitioner.Practitioner, spark_auto_mapper_fhir.resources.practitioner_role.PractitionerRole, spark_auto_mapper_fhir.resources.organization.Organization, spark_auto_mapper_fhir.resources.patient.Patient, spark_auto_mapper_fhir.resources.device.Device, spark_auto_mapper_fhir.resources.related_person.RelatedPerson]]]) –
enteredDate (Optional[spark_auto_mapper_fhir.fhir_types.date_time.FhirDateTime]) –
reason (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.codeable_concept.CodeableConcept[spark_auto_mapper_fhir.value_sets.icd_10_codes.ICD_10CodesCode]]]) –
service (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.reference.Reference[Union[spark_auto_mapper_fhir.resources.diagnostic_report.DiagnosticReport, spark_auto_mapper_fhir.resources.imaging_study.ImagingStudy, spark_auto_mapper_fhir.resources.immunization.Immunization, spark_auto_mapper_fhir.resources.medication_administration.MedicationAdministration, spark_auto_mapper_fhir.resources.medication_dispense.MedicationDispense, spark_auto_mapper_fhir.resources.observation.Observation, spark_auto_mapper_fhir.resources.procedure.Procedure, spark_auto_mapper_fhir.resources.supply_delivery.SupplyDelivery]]]]) –
productReference (Optional[spark_auto_mapper_fhir.complex_types.reference.Reference[Union[spark_auto_mapper_fhir.resources.device.Device, spark_auto_mapper_fhir.resources.medication.Medication, spark_auto_mapper_fhir.resources.substance.Substance]]]) –
productCodeableConcept (Optional[spark_auto_mapper_fhir.complex_types.codeable_concept.CodeableConcept[spark_auto_mapper_fhir.value_sets.generic_type.GenericTypeCode]]) –
account (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.reference.Reference[spark_auto_mapper_fhir.resources.account.Account]]]) –
note (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.annotation.Annotation]]) –
supportingInformation (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.reference.Reference[spark_auto_mapper_fhir.resources.resource.Resource]]]) –
- get_schema(self, include_extension)¶
- Parameters
include_extension (bool) –
- Return type
Optional[Union[pyspark.sql.types.StructType, pyspark.sql.types.DataType]]