xCaliber healthCare Data Mesh

Location

Overview

The Location API empowers healthcare developers to seamlessly manage and retrieve location information, providing a standardized interface for efficient integration of facility details into clinical workflows. By leveraging this API, developers can optimize patient routing, streamline appointment scheduling, and ensure accurate and up-to-date facility information for improved operational efficiency and patient experience in healthcare settings.

Use Cases

  • Asset Management - Associate location tags to health equipment using RFID for tracking.
  • Patient Flow - Map patient journey through different hospital departments and facilities.
  • Patient Transport - Route patient transfer requests to correct locations and departments.
  • GEO Analytics - Analyze patient distribution, disease patterns and outcomes based on geography.
  • Healthcare Networks - Construct facility hierarchies representing health system organization and structure.
  • Customer Relations - Push notifications to patients about visiting relevant locations through apps.
  • Staff Management - Assign, schedule staff roles across various practice locations.
  • Emergency response - Identify facility responsible for patients based on incident location.
  • Research data - Gain insights from care quality metrics and clinical trial data by sites.
  • Resource allocation - Distribute organization's budget, supplies optimally across locations.

EHR Data Model

EHRSupported?Mapped Source Object
AthenaPatient Location
ElationPractice-Location, Lab Vendor Patient Site, Appointment Room
EpicN/A

Object Definition

{
  "resourceType": "Location",
  "id": "1",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Burgers UMC, South Wing, second floor</div>"
  },
  "identifier": [
    {
      "value": "B1-S.F2"
    }
  ],
  "status": "active",
  "name": "South Wing, second floor",
  "alias": [
    "BU MC, SW, F2",
    "Burgers University Medical Center, South Wing, second floor"
  ],
  "description": "Second floor of the Old South Wing, formerly in use by Psychiatry",
  "mode": "instance",
  "telecom": [
    {
      "system": "phone",
      "value": "2328",
      "use": "work"
    },
    {
      "system": "fax",
      "value": "2329",
      "use": "work"
    },
    {
      "system": "email",
      "value": "second wing admissions"
    },
    {
      "system": "url",
      "value": "http://sampleorg.com/southwing",
      "use": "work"
    }
  ],
  "address": {
    "use": "work",
    "line": [
      "Galapagosweg 91, Building A"
    ],
    "city": "Den Burg",
    "postalCode": "9105 PZ",
    "country": "NLD"
  },
  "physicalType": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/location-physical-type",
        "code": "wi",
        "display": "Wing"
      }
    ]
  },
  "position": {
    "longitude": -83.6945691,
    "latitude": 42.25475478,
    "altitude": 0
  },
  "managingOrganization": {
    "reference": "Organization/f001"
  },
  "endpoint": [
    {
      "reference": "Endpoint/example"
    }
  ],
  "meta": {
    "tag": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason",
        "code": "HTEST",
        "display": "test health data"
      }
    ]
  }
}

Data Fields

Data FieldTypeDescription
resourceTypeLocationThis is a Location 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.
containedBackboneElementThese 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.
extensionExtensionMay 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.
modifierExtensionExtensionMay 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).
identifierIdentifierUnique code or number identifying the location to its users.
statuscodeThe status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.
operationalStatusCodingThe operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.
namestringName of the location as used by humans. Does not need to be unique.
aliasstringA list of alternate names that the location is known as, or was known as, in the past.
descriptionstringDescription of the Location, which helps in finding or referencing the place.
modecodeIndicates whether a resource instance represents a specific location or a class of locations.
typeCodeableConceptIndicates the type of function performed at the location.
telecomContactPointThe contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.
addressAddressPhysical location.
physicalTypeCodeableConceptPhysical form of the location, e.g. building, room, vehicle, road.
positionBackboneElementThe absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
position.idstringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
position.extensionExtensionMay be used to represent additional information that is not part of the basic definition of the element. 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.
position.modifierExtensionExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).
position.longitudedecimalLongitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).
position.latitudedecimalLatitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).
position.altitudedecimalAltitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).
managingOrganizationReferenceThe organization responsible for the provisioning and upkeep of the location.
partOfReferenceAnother Location of which this Location is physically a part of.
hoursOfOperationBackboneElementWhat days/times during a week is this location usually open.
hoursOfOperation.idstringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
hoursOfOperation.extensionExtensionMay be used to represent additional information that is not part of the basic definition of the element. 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.
hoursOfOperation.modifierExtensionExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).
hoursOfOperation.daysOfWeekcodeIndicates which days of the week are available between the start and end Times.
hoursOfOperation.allDaybooleanThe Location is open all day.
hoursOfOperation.openingTimetimeTime that the Location opens.
hoursOfOperation.closingTimetimeTime that the Location closes.
availabilityExceptionsstringA description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times.
endpointReferenceTechnical endpoints providing access to services operated for the location.

Extensions

NameURL
NAMEhttp://xcaliber-fhir/structureDefinition/name
PRIMARYhttp://xcaliber-fhir/structureDefinition/primary
CREATED_DATEhttp://xcaliber-fhir/structureDefinition/created-date
DELETED_DATEhttp://xcaliber-fhir/structureDefinition/deleted-date
CHARTSHARINGGROUPIDhttp://xcaliber-fhir/structureDefinition/chart-sharing-group-id
CLINICALPROVIDERFAXhttp://xcaliber-fhir/structureDefinition/clinical-provider-fax
CLINICALShttp://xcaliber-fhir/structureDefinition/clinicals
COMMUNICATORBRANDIDhttp://xcaliber-fhir/structureDefinition/communicator-brand-id
CREDITCARDTYPEShttp://xcaliber-fhir/structureDefinition/credit-card-types
DOESNOTOBSERVEDSThttp://xcaliber-fhir/structureDefinition/does-not-observed-st
ECOMMERCECREDITCARDTYPEShttp://xcaliber-fhir/structureDefinition/ecommerce-credit-card-types
ISHOSPITALDEPARTMENThttp://xcaliber-fhir/structureDefinition/is-hospital-department
MEDICATIONHISTORYCONSENThttp://xcaliber-fhir/structureDefinition/medication-history-consent
ONEYEARCONTRACTMAXhttp://xcaliber-fhir/structureDefinition/one-year-contract-max
PATIENTDEPARTMENTNAMEhttp://xcaliber-fhir/structureDefinition/patient-department-name
PLACEOFSERVICEFACILITYhttp://xcaliber-fhir/structureDefinition/place-of-service-facility
PLACEOFSERVICETYPEIDhttp://xcaliber-fhir/structureDefinition/place-of-service-type-id
PORTALURLhttp://xcaliber-fhir/structureDefinition/portal-url
PROVIDERGROUPIDhttp://xcaliber-fhir/structureDefinition/provider-group-id
PROVIDERGROUPNAMEhttp://xcaliber-fhir/structureDefinition/provider-group-name
PROVIDERLISThttp://xcaliber-fhir/structureDefinition/provider-list
SERVICEDEPARTMENThttp://xcaliber-fhir/structureDefinition/service-department
SINGLEAPPOINTMENTCONTRACTMAXhttp://xcaliber-fhir/structureDefinition/single-appointment-contract-max
TIMEZONEhttp://xcaliber-fhir/structureDefinition/timezone
TIMEZONENAMEhttp://xcaliber-fhir/structureDefinition/timezone-name
TIMEZONEOFFSEThttp://xcaliber-fhir/structureDefinition/timezone-offset
TYPEOFBILLhttp://xcaliber-fhir/structureDefinition/type-of-bill
DEPARTMENTIDhttp://xcaliber-fhir/structureDefinition/department-id
PLACEOFSERVICETYPEhttp://xcaliber-fhir/structureDefinition/place-of-service-type
FEDERAL_TAX_IDhttp://xcaliber-fhir/structureDefinition/federal-tax-id
PATIENThttp://xcaliber-fhir/structureDefinition/patient-id

Operations & APIs

Location-GET

Location-POST

Location ID-GET

Location ID-PUT

Location ID-DELETE

Location Export-POST