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.

Nictiz profile: Location

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	Location	This is a Location resource
identifier	array(Identifier)		Unique code or number identifying the location to its users.
status	string	active\|suspended\|inactive	The 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.
operationalStatus	Coding		The 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.
name	string		Name of the location as used by humans. Does not need to be unique.
alias	array()		A list of alternate names that the location is known as, or was known as in the past.
description	string		Description of the Location, which helps in finding or referencing the place.
mode	string	instance\|kind	Indicates whether a resource instance represents a specific location or a class of locations.
type	CodeableConcept		Indicates the type of function performed at the location.
telecom	array(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.
address	Address		Physical location.
physicalType	CodeableConcept		Physical form of the location, e.g. building, room, vehicle, road.
position	Location_Position		The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
managingOrganization	Reference		The organization responsible for the provisioning and upkeep of the location.
partOf	Reference		Another Location which this Location is physically part of.
endpoint	array(Reference)		Technical endpoints providing access to services operated for the location.

Response

200 400 401 404

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.

Nictiz profile: Location

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	Location	This is a Location resource
identifier	array(Identifier)		Unique code or number identifying the location to its users.
status	string	active\|suspended\|inactive	The 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.
operationalStatus	Coding		The 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.
name	string		Name of the location as used by humans. Does not need to be unique.
alias	array()		A list of alternate names that the location is known as, or was known as in the past.
description	string		Description of the Location, which helps in finding or referencing the place.
mode	string	instance\|kind	Indicates whether a resource instance represents a specific location or a class of locations.
type	CodeableConcept		Indicates the type of function performed at the location.
telecom	array(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.
address	Address		Physical location.
physicalType	CodeableConcept		Physical form of the location, e.g. building, room, vehicle, road.
position	Location_Position		The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
managingOrganization	Reference		The organization responsible for the provisioning and upkeep of the location.
partOf	Reference		Another Location which this Location is physically part of.
endpoint	array(Reference)		Technical endpoints providing access to services operated for the location.

Response

200 400 401 404

get

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

Nictiz profile: Location

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 400 401 404

get

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

Nictiz profile: Location

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 400 401 404

get

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

Nictiz profile: Location

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string	id\|slug
resourceId*
versionId*

Response

200 400 401 404

delete

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

Nictiz profile: Location

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 400 401 404

get

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

Nictiz profile: Location

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
address	string
address-city	string
address-country	string
address-postalcode	string
address-state	string
address-use	string
endpoint	string
identifier	string
name	string
near	string
near-distance	string
operational-status	string
organization	string
partof	string
status	string
type	string

Params


organizationId*	string\|string		id\|slug

Response

200 400 401 404

get

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

Nictiz profile: Location

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug

Response

200 400 401 404

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.

Nictiz profile: Location

Request

Headers


content-type*	string	application/json\|application/x-www-form-urlencoded	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
address	string
address-city	string
address-country	string
address-postalcode	string
address-state	string
address-use	string
endpoint	string
identifier	string
name	string
near	string
near-distance	string
operational-status	string
organization	string
partof	string
status	string
type	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	Location	This is a Location resource
identifier	array(Identifier)		Unique code or number identifying the location to its users.
status	string	active\|suspended\|inactive	The 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.
operationalStatus	Coding		The 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.
name	string		Name of the location as used by humans. Does not need to be unique.
alias	array()		A list of alternate names that the location is known as, or was known as in the past.
description	string		Description of the Location, which helps in finding or referencing the place.
mode	string	instance\|kind	Indicates whether a resource instance represents a specific location or a class of locations.
type	CodeableConcept		Indicates the type of function performed at the location.
telecom	array(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.
address	Address		Physical location.
physicalType	CodeableConcept		Physical form of the location, e.g. building, room, vehicle, road.
position	Location_Position		The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
managingOrganization	Reference		The organization responsible for the provisioning and upkeep of the location.
partOf	Reference		Another Location which this Location is physically part of.
endpoint	array(Reference)		Technical endpoints providing access to services operated for the location.

Response

200 400 401 404

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.

Nictiz profile: Location

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	Location	This is a Location resource
identifier	array(Identifier)		Unique code or number identifying the location to its users.
status	string	active\|suspended\|inactive	The 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.
operationalStatus	Coding		The 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.
name	string		Name of the location as used by humans. Does not need to be unique.
alias	array()		A list of alternate names that the location is known as, or was known as in the past.
description	string		Description of the Location, which helps in finding or referencing the place.
mode	string	instance\|kind	Indicates whether a resource instance represents a specific location or a class of locations.
type	CodeableConcept		Indicates the type of function performed at the location.
telecom	array(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.
address	Address		Physical location.
physicalType	CodeableConcept		Physical form of the location, e.g. building, room, vehicle, road.
position	Location_Position		The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
managingOrganization	Reference		The organization responsible for the provisioning and upkeep of the location.
partOf	Reference		Another Location which this Location is physically part of.
endpoint	array(Reference)		Technical endpoints providing access to services operated for the location.

Response

200 400 401 404