spark_auto_mapper_fhir.resources.account
¶
Module Contents¶
Classes¶
Account |
- class spark_auto_mapper_fhir.resources.account.Account(*, id_=None, meta=None, implicitRules=None, language=None, text=None, contained=None, extension=None, modifierExtension=None, identifier=None, status, type_=None, name=None, subject=None, servicePeriod=None, coverage=None, owner=None, description=None, guarantor=None, partOf=None)¶
Bases:
spark_auto_mapper_fhir.base_types.fhir_resource_base.FhirResourceBase
Account account.xsd
A financial tool for tracking value accrued for a particular purpose. In the
- healthcare field, used to track charges for a patient, cost centers, etc.
If the element is present, it must have either a @value, an @id, or extensions
A financial tool for tracking value accrued for a particular purpose. In the
- healthcare field, used to track charges for a patient, cost centers, etc.
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
Unique identifier used to reference the account. Might or might not be
- intended for human use (e.g. credit card number).
- param status
Indicates whether the account is presently used/usable or not.
- param type_
Categorizes the account for reporting and searching purposes.
- param name
Name used for the account when displaying it to humans in reports, etc.
- param subject
Identifies the entity which incurs the expenses. While the immediate
recipients of services or goods might be entities related to the subject, the expenses were ultimately incurred by the subject of the Account.
- param servicePeriod
The date range of services associated with this account.
- param coverage
The party(s) that are responsible for covering the payment of this account,
- and what order should they be applied to the account.
- param owner
Indicates the service area, hospital, department, etc. with responsibility for
- managing the Account.
- param description
Provides additional information about what the account tracks and how it is
- used.
- param guarantor
The parties responsible for balancing the account if other payment options
- fall short.
- param partOf
Reference to a parent Account.
- 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]]) –
status (spark_auto_mapper_fhir.value_sets.account_status.AccountStatusCode) –
type_ (Optional[spark_auto_mapper_fhir.complex_types.codeable_concept.CodeableConcept[spark_auto_mapper_fhir.value_sets.account_types.AccountTypesCode]]) –
name (Optional[spark_auto_mapper_fhir.fhir_types.string.FhirString]) –
subject (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.reference.Reference[Union[spark_auto_mapper_fhir.resources.patient.Patient, spark_auto_mapper_fhir.resources.device.Device, spark_auto_mapper_fhir.resources.practitioner.Practitioner, spark_auto_mapper_fhir.resources.practitioner_role.PractitionerRole, spark_auto_mapper_fhir.resources.location.Location, spark_auto_mapper_fhir.resources.healthcare_service.HealthcareService, spark_auto_mapper_fhir.resources.organization.Organization]]]]) –
servicePeriod (Optional[spark_auto_mapper_fhir.complex_types.period.Period]) –
coverage (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.backbone_elements.account_coverage.AccountCoverage]]) –
owner (Optional[spark_auto_mapper_fhir.complex_types.reference.Reference[spark_auto_mapper_fhir.resources.organization.Organization]]) –
description (Optional[spark_auto_mapper_fhir.fhir_types.string.FhirString]) –
guarantor (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.backbone_elements.account_guarantor.AccountGuarantor]]) –
partOf (Optional[spark_auto_mapper_fhir.complex_types.reference.Reference[Account]]) –
- get_schema(self, include_extension)¶
- Parameters
include_extension (bool) –
- Return type
Optional[Union[pyspark.sql.types.StructType, pyspark.sql.types.DataType]]