Location - FHIR Resource (stu3)


This Location Resource uses the FHIR API standard for access and structure.

Validate an Location FHIR Resource (stu3)



Resource Attributes

AttributeField is listTypeDescription
addressfalseAddress# Physical location
aliastruestring# A list of alternate names that the location is known as, or was known as in the past
descriptionfalsestring# Additional details about the location that could be displayed as further information to identify the location beyond its name
endpointtrueReference# Technical endpoints providing access to services operated for the location
identifiertrueIdentifier# Unique code or number identifying the location to its users
managingOrganizationfalseReference# Organization responsible for provisioning and upkeep
modefalsecode# instance | kind
namefalsestring# Name of the location as used by humans
operationalStatusfalseCoding# The Operational status of the location (typically only for a bed/room)
partOffalseReference# Another Location this one is physically part of
physicalTypefalseCodeableConcept# Physical form of the location
positionfalseData Type# The absolute geographic location
statusfalsecode# active | suspended | inactive
telecomtrueContactPoint# Contact details of the location
typefalseCodeableConcept# Type of function performed

Location Example

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

Location Structure


  
{
  "resourceType" : "Location",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Unique code or number identifying the location to its users
  "status" : "<code>", // active | suspended | inactive
  "operationalStatus" : { Coding }, // The Operational status of the location (typically only for a bed/room)
  "name" : "<string>", // Name of the location as used by humans
  "alias" : ["<string>"], // A list of alternate names that the location is known as, or was known as in the past
  "description" : "<string>", // Additional details about the location that could be displayed as further information to identify the location beyond its name
  "mode" : "<code>", // instance | kind
  "type" : { CodeableConcept }, // Type of function performed
  "telecom" : [{ ContactPoint }], // Contact details of the location
  "address" : { Address }, // Physical location
  "physicalType" : { CodeableConcept }, // Physical form of the location
  "position" : { // The absolute geographic location
    "longitude" : <decimal>, // R!  Longitude with WGS84 datum
    "latitude" : <decimal>, // R!  Latitude with WGS84 datum
    "altitude" : <decimal> // Altitude with WGS84 datum
  },
  "managingOrganization" : { Reference(Organization) }, // Organization responsible for provisioning and upkeep
  "partOf" : { Reference(Location) }, // Another Location this one is physically part of
  "endpoint" : [{ Reference(Endpoint) }] // Technical endpoints providing access to services operated for the location
}


 

Location Search Parameters

The following search parameters can be used to query Location resources. Just submit the like so:

https://api.1up.health/fhir/stu3/Location?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
addresstextaddress
address-citytextaddress.city
address-countrytextaddress.country
address-postalcodetextaddress.postalCode
address-statetextaddress.state
address-usetextaddress.use
endpointreferenceendpoint
identifiertextidentifier
nametextname, alias
neartextposition
near-distancequantityposition
operational-statustextoperationalStatus
organizationreferencemanagingOrganization
partofreferencepartOf
statustextstatus
typetexttype