locations

post
/organizations/{organizationId}/fhir/3/location

Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

Params

organizationId*string|stringid|slug

Body

resourceType*stringLocationThis is a Location resource
identifierarray(Identifier)Unique code or number identifying the location to its users.
statusstringactive|suspended|inactiveThe 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/chair/etc such as an isolation unit/dialisys 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.
aliasarray()A 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.
modestringinstance|kindIndicates whether a resource instance represents a specific location or a class of locations.
typeCodeableConceptIndicates the type of function performed at the location.
telecomarray(ContactPoint)The 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.
positionLocation_PositionThe absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
managingOrganizationReferenceThe organization responsible for the provisioning and upkeep of the location.
partOfReferenceAnother Location which this Location is physically part of.
endpointarray(Reference)Technical endpoints providing access to services operated for the location.

Response

patch
/organizations/{organizationId}/fhir/3/location/{resourceId}

Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringLocationThis is a Location resource
identifierarray(Identifier)Unique code or number identifying the location to its users.
statusstringactive|suspended|inactiveThe 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/chair/etc such as an isolation unit/dialisys 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.
aliasarray()A 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.
modestringinstance|kindIndicates whether a resource instance represents a specific location or a class of locations.
typeCodeableConceptIndicates the type of function performed at the location.
telecomarray(ContactPoint)The 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.
positionLocation_PositionThe absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
managingOrganizationReferenceThe organization responsible for the provisioning and upkeep of the location.
partOfReferenceAnother Location which this Location is physically part of.
endpointarray(Reference)Technical endpoints providing access to services operated for the location.

Response

get
/organizations/{organizationId}/fhir/3/location/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

Params

organizationId*string|stringid|slug
resourceId*

Response

get
/organizations/{organizationId}/fhir/3/location/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

get
/organizations/{organizationId}/fhir/3/location/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

delete
/organizations/{organizationId}/fhir/3/location/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

Params

organizationId*string|stringid|slug
resourceId*

Response

get
/organizations/{organizationId}/fhir/3/location

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
addressstring
address-citystring
address-countrystring
address-postalcodestring
address-statestring
address-usestring
endpointstring
identifierstring
namestring
nearstring
near-distancestring
operational-statusstring
organizationstring
partofstring
statusstring
typestring

Params

organizationId*string|stringid|slug

Response

get
/organizations/{organizationId}/fhir/3/location/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

post
/organizations/{organizationId}/fhir/3/location/_search

Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
addressstring
address-citystring
address-countrystring
address-postalcodestring
address-statestring
address-usestring
endpointstring
identifierstring
namestring
nearstring
near-distancestring
operational-statusstring
organizationstring
partofstring
statusstring
typestring

Params

organizationId*string|stringid|slug

Body

resourceType*stringLocationThis is a Location resource
identifierarray(Identifier)Unique code or number identifying the location to its users.
statusstringactive|suspended|inactiveThe 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/chair/etc such as an isolation unit/dialisys 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.
aliasarray()A 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.
modestringinstance|kindIndicates whether a resource instance represents a specific location or a class of locations.
typeCodeableConceptIndicates the type of function performed at the location.
telecomarray(ContactPoint)The 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.
positionLocation_PositionThe absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
managingOrganizationReferenceThe organization responsible for the provisioning and upkeep of the location.
partOfReferenceAnother Location which this Location is physically part of.
endpointarray(Reference)Technical endpoints providing access to services operated for the location.

Response

put
/organizations/{organizationId}/fhir/3/location/{resourceId}

Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringLocationThis is a Location resource
identifierarray(Identifier)Unique code or number identifying the location to its users.
statusstringactive|suspended|inactiveThe 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/chair/etc such as an isolation unit/dialisys 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.
aliasarray()A 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.
modestringinstance|kindIndicates whether a resource instance represents a specific location or a class of locations.
typeCodeableConceptIndicates the type of function performed at the location.
telecomarray(ContactPoint)The 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.
positionLocation_PositionThe absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
managingOrganizationReferenceThe organization responsible for the provisioning and upkeep of the location.
partOfReferenceAnother Location which this Location is physically part of.
endpointarray(Reference)Technical endpoints providing access to services operated for the location.

Response