Location - FHIR Resource (dstu2)


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

Resource Attributes

AttributeField is listTypeDescription
addressfalseAddress Physical location
descriptionfalsestring Description of 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
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 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
  "name" : "<string>", // Name of the location as used by humans
  "description" : "<string>", // Description of the location
  "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
}


 

Location Search Parameters

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

https://api.1up.health/fhir/dstu2/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
identifiertextidentifier
nametextname
neartextposition
near-distancetextposition
organizationreferencemanagingOrganization
partofreferencepartOf
statustextstatus
typetexttype