Patient Location
Source Object: Patient Location
Overview and Usage: The "Patient Location" source object plays a pivotal role in healthcare systems for effectively managing and organizing patient-related information. It encompasses details about the location or facility where healthcare services are provided to patients. This information is vital for healthcare practitioners, administrators, and systems to ensure the smooth functioning of healthcare operations. The key fields included in this source object are:
- Address: The physical address of the patient location, enabling accurate location identification.
- Address2: Additional address information, if necessary, to provide more detailed location description.
- City: The city in which the patient location is situated.
- DepartmentId: A unique identifier for the department responsible for managing the patient location, facilitating organizational structure.
- Fax: The fax number associated with the patient location, which is important for communication and documentation.
- Latitude and Longitude: Geographic coordinates representing the exact location of the facility, aiding in mapping and navigation.
- Name: The name or label of the patient location, helping to distinguish it from other facilities within the healthcare system.
- Phone: The contact phone number for the patient location, essential for communication and appointment scheduling.
- PlaceOfServiceTypeName: A descriptor for the type of healthcare service provided at this location (e.g., hospital, clinic, or office).
- State: The state in which the patient location is located.
- Zip: The postal code or ZIP code of the patient location, assisting in precise address validation.
- ChartSharingGroupId: If relevant, an identifier that groups multiple patient charts or records associated with this location.
- ClinicalProviderFax: The fax number specific to clinical providers at this location, separate from general communication.
- IsHospitalDepartment: A flag indicating whether the patient location is a hospital department, which influences healthcare service categorization.
- MedicationHistoryConsent: Records whether the patient location has obtained consent to access the patient's medication history, ensuring regulatory compliance and data security.
- ProviderGroupName: The name of the group of healthcare providers associated with this patient location.
- TimeZone and TimeZoneOffset: Information about the time zone in which the patient location is situated, helping in scheduling and appointment management.
- TypeOfBill: An indicator that specifies the type of billing associated with this location, which has financial and administrative implications.
The "Patient Location" source object ensures accurate and efficient patient management, appointment scheduling, and healthcare service delivery. It is essential for healthcare systems to maintain a comprehensive record of patient locations, enabling effective communication, service categorization, and billing. This source object aids in optimizing healthcare operations and ensuring quality patient care.
Mapping Table
| Data Field | Example Value | Source Data Field Description | Source Field Data Type | Source Data Field Cardinality | Mapped FHIR++ Resource | Mapped FHIR Data Field | Augmented Mapping | Associated Coding System | Associated FHIR Data Field Extension | Mapping Context |
|---|---|---|---|---|---|---|---|---|---|---|
| address | - | The address for this department. | String | 0..1 | Location | address.line[1] | - | - | - | Top Level |
| address2 | - | The address (line 2) for this department. | String | 0..1 | Location | address.line[2] | - | - | - | Top Level |
| city | - | The city for this department. | String | 0..1 | Location | address.city | - | - | - | Top Level |
| departmentid | - | The department ID. This ID is local to each practice. | String | 1..1 | Location | id | - | - | - | Top Level |
| fax | - | This is the department's fax number. Sometimes this is not configured even though the department can receive faxes. This happens when the main clinical provider has their fax number set up but the department does not. You should check both this field and the "clinicalproviderfax" field when determining if faxes are possible. | String | 0..1 | Location | telecom[*].value | - | - | Top Level | |
| latitude | - | The latitude may be set by the practice to correct any bad public mapping data. In degrees, with a decimal component. | String | 0..1 | Location | position.latitute | - | - | - | Top Level |
| longitude | - | The longitude may be set by the practice to correct any bad public mapping data. In degrees, with a decimal component. | String | 0..1 | Location | position.longtitude | - | - | - | Top Level |
| name | - | The department's name. | String | 0..1 | Location | name | - | - | - | Top Level |
| phone | - | This number is not always patient-facing; it may be a "back line". | String | 0..1 | Location | telecom[*].value | system=phone | - | - | Top Level |
| placeofservicetypename | - | The name describing the type of service location (e.g. office vs. hospital) | String | 0..1 | Location | type[1].coding[1].display | system=http://xcaliber-fhir/structureDefinition/place-of-service-type | - | - | Top Level |
| state | - | The state for this department. | String | 0..1 | Location | address.state | - | - | - | Top Level |
| zip | - | The zip code for this department. | String | 0..1 | Location | address.postalCode | - | - | - | Top Level |
| chartsharinggroupid | - | The chart sharing group ID puts departments (that are enabled for Clinicals) into groups with regards to clinical information. Any chart related GET calls with department IDs that are in the same chart sharing group generally return the same set of information. For example, if department IDs 1 and 2 are in chart sharing group 1000 and department IDs 20 and 21 are in chart sharing group 2000, the allergies endpoint for department ID 1 or 2 will return the same set of data, and using department IDs 20 and 21 may return a different set of allergies. Most commonly, this is used to ensure mental health and other sensitive charts remain separate from other data. | String | 0..1 | Location | extension[*].valueString | - | - | chart-sharing-group-id | Top Level |
| clinicalproviderfax | - | This is the department's fax number for receiving orders. | String | 0..1 | Location | telecom[*].value | system=fax, extension={ url:http://xcaliber-fhir/structureDefinition/clinical-provider-fax, valueString="CLINICALPROVIDERFAX"} | - | clinical-provider-fax | Top Level |
| clinicals | - | Is Clinicals turned on for this department. Possible values are "ON "OFF "DOCUMENTSONLY" (which means that they accept documents, but generally not doing encounters in Clinicals) or "ADMINONLY" which for most purposes is the same as "OFF though means that it is in the middle of implementation. | String | 0..1 | Location | extension[*].valueString | - | - | clinicals | Top Level |
| communicatorbrandid | - | The ID of the patient-facing brand this department belongs to. | String | 0..1 | Location | extension[*].valueString | - | - | communicator-brand-id | Top Level |
| creditcardtypes | - | An array of credit card types accepted in this department (for retail transactions). If not present, credit cards can not be processed for this department for retail transactions. | String | 0..1 | Location | extension[*].valueString | - | - | credit-card-types | Top Level |
| doesnotobservedst | - | Set to true if this practice does not observe daylight savings time. | String | 0..1 | Location | extension[*].valueString | - | - | does-not-observed-st | Top Level |
| ecommercecreditcardtypes | - | An array of credit card types accepted in this department (for ecommerce transactions). If not present, credit cards can not be processed for this department for ecommerce transactions. | String | 0..1 | Location | extension[*].valueString | - | - | ecommerce-credit-card-types | Top Level |
| ishospitaldepartment | - | Flag denoting if this department is a hospital department. | String | 0..1 | Location | extension[*].valueString | - | - | is-hospital-department | Top Level |
| medicationhistoryconsent | - | Should medication history consent be asked in this practice. This is a practice-wide setting at the end of the day; if it is on for one Clinicals department (of status "ON"), it will be on for all Clinicals departments. | String | 0..1 | Location | extension[*].valueString | - | - | medication-history-consent | Top Level |
| oneyearcontractmax | - | For a year long payment contract, the practice's suggested maximum amount for this department. | String | 0..1 | Location | extension[*].valueString | - | - | one-year-contract-max | Top Level |
| patientdepartmentname | - | The patient-friendly name for this department, if set by the practice. | String | 0..1 | Location | extension[*].valueString | - | - | patient-department-name | Top Level |
| placeofservicefacility | - | Is this department a "facility" or not | String | 0..1 | Location | extension[*].valueString | - | - | place-of-service-acility | Top Level |
| placeofservicetypeid | - | An athena-internal ID for the type of service location (e.g. office vs. hospital) | String | 0..1 | Location | type[1].coding[1].code | - | - | - | Top Level |
| portalurl | - | The URL for the practice or the portal, if available, for this department. This may be the practice's website where they have a link to the portal. | String | 0..1 | Location | extension[*].valueString | - | - | portal-url | Top Level |
| providergroupid | - | The ID of the financial group this department belongs to. Not all practices have distinct financial groups. | String | 0..1 | Location | extension[*].valueString | - | - | provider-group-id | Top Level |
| providergroupname | - | The name of the financial group this department belongs to. Not all practices have distinct financial groups. | String | 0..1 | Location | extension[*].valueString | - | - | provider-group-name | Top Level |
| providerlist | - | If providerlist is passed in (set to true), a list of provider IDs | String | 0..1 | Location | extension[*].valueString | - | - | provider-list | Top Level |
| servicedepartment | - | Indicates if this is a department where billable services are performed (i.e. a department where you can create claims). | String | 0..1 | Location | extension[*].valueString | - | - | service-department | Top Level |
| singleappointmentcontractmax | - | For a single appointment payment contract, the practice's suggested maximum amount for this department. | String | 0..1 | Location | extension[*].valueString | - | - | single-appointment-contract-max | Top Level |
| timezone | - | The timezone for this department, offset from UTC/GMT. | String | 0..1 | Location | extension[*].valueString | - | - | timezone | Top Level |
| timezonename | - | Timezone name of the department. | String | 0..1 | Location | extension[*].valueString | - | - | timezone-name | Top Level |
| timezoneoffset | - | The "normal" timezone offset from UTC/GMT. The "timezone" combines this and "doesnotobservedst". During daylight savings, this is 1 less than "timezone". | String | 0..1 | Location | extension[*].valueString | - | - | timezone-offset | Top Level |
| typeofbill | - | This is the name of type of bill for the department. | String | 0..1 | Location | extension[*].valueString | - | - | type-of-bill | Top Level |