R4 Location

The Location resource describes the "Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated." (HL7 FHIR R4 Location)

Supported Profiles

This API supports the following FHIR profiles:

• HL7 FHIR R4 Location

Operations

The General Purpose FHIR R4 Location resource supports the following standard operations. However, support varies by the targeted CareRecord or solution.

CareRecord / Solution	Create	Read	Update	Search
GEHRIMED	-	Yes	-	Yes
myAvatar	Yes	Yes	Yes	Yes
myEvolv	-	Yes	-	Yes
myUnity	-	Yes	-	Yes
Referral Manager	-	-	-	-

Search

info

Not all Netsmart solutions support Location search. See supported operations table above and consult your target solution's documentation for more information.

This resource supports a combination of standard and custom search parameters in addition to the common parameters.

Standard Parameters

Name	Type	Description
address-state	string	A state specified in an address
address-city	string	A city specified in an address
address-postalcode	string	A postal code specified in an address
identifier	token	An identifier for the location
name	string	A portion of the location's name or alias
organization	reference	Searches for locations that are managed by the provided organization
partof	reference	A location of which this location is a part

Custom Parameters

Name	Type	Description
end	date	Deprecated. Use date parameter with le prefix instead.
practitioner	reference	The practitioner ID to be used for the search.
start	date	Deprecated. Use date parameter with ge prefix instead.

Search Examples

The POST method is recommended as it keeps health information out of the URL.

Production

Search Locations by city

curl -X POST https://fhir.netsmartcloud.com/v4/Location/_search \
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json" \
    -H "Content-Type: application/x-form-urlencoded" \
    -d "address-city=Kansas City" \
    

Preview

Search Locations by city

curl -X POST https://fhirtest.netsmartcloud.com/v4/Location/_search \
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json" \
    -H "Content-Type: application/x-form-urlencoded" \
    -d "address-city=Kansas City" \
    

Extended Operations

In addition to the standard operations described above, we have also implemented extended operations on the Location resource. These extended operations are not intended for CareRecord use as these operations bypass the CareRecords to communicate with FHIR directly.

Create Relay ($create-relay)

Experimental

This is an experimental operation within CareConnect that is not yet supported by any Netsmart CareRecord or other solution.

The Resource Create Relay operation is used to relay requests to another FHIR server.

Read Relay ($read-relay)

Experimental

This is an experimental operation within CareConnect that is not yet supported by any Netsmart CareRecord or other solution.

The Resource Read Relay operation is used to relay requests to another FHIR server.

Update Relay ($update-relay)

Experimental

This is an experimental operation within CareConnect that is not yet supported by any Netsmart CareRecord or other solution.

The Resource Update Relay operation is used to relay requests to another FHIR server.

Search Relay ($search-relay)

Experimental

This is an experimental operation within CareConnect that is not yet supported by any Netsmart CareRecord or other solution.

The Resource Search Relay operation is used to relay requests to another FHIR server.