HDR FHIR API

GET Location Resource Bundle

get

/oracle-fhir-server/fhir/Location

This endpoint supports the retrieval of Location resource list.It returns Bundle of Location resource.

Request

Query Parameters

_format(optional): string
_id(optional): string

The ID of the resource
_language(optional): string

The language of the resource
address(optional): string

A (part of the) address of the location
address-city(optional): string

A city specified in an address
address-country(optional): string

A country specified in an address
address-postalcode(optional): string

A postal code specified in an address
address-state(optional): string

A state specified in an address
address-use(optional): string

A use code specified in an address
endpoint(optional): string

Technical endpoints providing access to services operated for the location
identifier(optional): string

An identifier for the location
name(optional): string

A portion of the location's name or alias
near(optional): string

Search for locations where the location.position is near to, or within a specified distance of, the provided coordinates expressed as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, see notes). If the units are omitted, then kms should be assumed. If the distance is omitted, then the server can use its own discretion as to what distances should be considered near (and units are irrelevant) Servers may search using various techniques that might have differing accuracies, depending on implementation efficiency. Requires the near-distance parameter to be provided also
operational-status(optional): string

Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping)
organization(optional): string

Searches for locations that are managed by the provided organization
partof(optional): string

A location of which this location is a part
status(optional): string

Searches for locations with a specific kind of status
type(optional): string

A code for the type of location

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object Location

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Location"
    }
}

Nested Schema : Location

Type: object

Show Source

address: object Location_address
alias: array alias
description: string

Minimum Length: 1
endpoint: array endpoint

Minimum Number of Items: 1

Unique Items Required: true
id: string

Minimum Length: 1
identifier: array identifier

Minimum Number of Items: 1

Unique Items Required: true
managingOrganization: object Account_coverage
meta: object Account_meta
mode: string

Minimum Length: 1
name: string

Minimum Length: 1
physicalType: object ActivityDefinition_valueCodeableConcept
position: object Location_position
resourceType: string

Minimum Length: 1
status: string

Minimum Length: 1
telecom: array telecom

Minimum Number of Items: 1

Unique Items Required: true
text: object Account_text

{
    "type":"object",
    "required":[
        "address",
        "alias",
        "description",
        "endpoint",
        "id",
        "identifier",
        "managingOrganization",
        "meta",
        "mode",
        "name",
        "physicalType",
        "position",
        "resourceType",
        "status",
        "telecom",
        "text"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "identifier":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AuditEvent_who_identifier"
            },
            "minItems":1
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "name":{
            "type":"string",
            "minLength":1
        },
        "alias":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                }
            }
        },
        "description":{
            "type":"string",
            "minLength":1
        },
        "mode":{
            "type":"string",
            "minLength":1
        },
        "telecom":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_telecom"
            },
            "minItems":1
        },
        "address":{
            "$ref":"#/definitions/Location_address"
        },
        "physicalType":{
            "$ref":"#/definitions/ActivityDefinition_valueCodeableConcept"
        },
        "position":{
            "$ref":"#/definitions/Location_position"
        },
        "managingOrganization":{
            "$ref":"#/definitions/Account_coverage"
        },
        "endpoint":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : Location_address

Type: object

Show Source

city: string

Minimum Length: 1
country: string

Minimum Length: 1
line: array line
postalCode: string

Minimum Length: 1
use: string

Minimum Length: 1

{
    "required":[
        "city",
        "country",
        "line",
        "postalCode",
        "use"
    ],
    "properties":{
        "use":{
            "type":"string",
            "minLength":1
        },
        "line":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                }
            }
        },
        "city":{
            "type":"string",
            "minLength":1
        },
        "postalCode":{
            "type":"string",
            "minLength":1
        },
        "country":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : alias

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
        }
    }
}

Nested Schema : endpoint

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_coverage

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_coverage"
    },
    "minItems":1
}

Nested Schema : identifier

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object AuditEvent_who_identifier

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/AuditEvent_who_identifier"
    },
    "minItems":1
}

Nested Schema : Account_coverage

Type: object

Show Source

reference: string

Minimum Length: 1

{
    "required":[
        "reference"
    ],
    "properties":{
        "reference":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : Account_meta

Type: object

Show Source

tag: array tag

Minimum Number of Items: 1

Unique Items Required: true

{
    "required":[
        "tag"
    ],
    "properties":{
        "tag":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_type_coding"
            },
            "minItems":1
        }
    }
}

Nested Schema : ActivityDefinition_valueCodeableConcept

Type: object

Show Source

coding: array coding

Minimum Number of Items: 1

Unique Items Required: true

{
    "required":[
        "coding"
    ],
    "properties":{
        "coding":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_type_coding"
            },
            "minItems":1
        }
    }
}

Nested Schema : Location_position

Type: object

Show Source

altitude: number
latitude: number
longitude: number

{
    "required":[
        "altitude",
        "latitude",
        "longitude"
    ],
    "properties":{
        "longitude":{
            "type":"number"
        },
        "latitude":{
            "type":"number"
        },
        "altitude":{
            "type":"number"
        }
    }
}

Nested Schema : telecom

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_telecom

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ActivityDefinition_telecom"
    },
    "minItems":1
}

Nested Schema : Account_text

Type: object

Show Source

div: string

Minimum Length: 1
status: string

Minimum Length: 1

{
    "required":[
        "div",
        "status"
    ],
    "properties":{
        "status":{
            "type":"string",
            "minLength":1
        },
        "div":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : line

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
        }
    }
}

Nested Schema : items

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : items

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : AuditEvent_who_identifier

Type: object

Show Source

value: string

Minimum Length: 1

{
    "required":[
        "value"
    ],
    "properties":{
        "value":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : tag

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_type_coding

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_type_coding"
    },
    "minItems":1
}

Nested Schema : Account_type_coding

Type: object

Show Source

code: string

Minimum Length: 1
display: string

Minimum Length: 1
system: string

Minimum Length: 1

{
    "required":[
        "code",
        "display",
        "system"
    ],
    "properties":{
        "system":{
            "type":"string",
            "minLength":1
        },
        "code":{
            "type":"string",
            "minLength":1
        },
        "display":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_type_coding

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_type_coding"
    },
    "minItems":1
}

Nested Schema : ActivityDefinition_telecom

Type: object

Show Source

system: string

Minimum Length: 1
use: string

Minimum Length: 1
value: string

Minimum Length: 1

{
    "required":[
        "system",
        "use",
        "value"
    ],
    "properties":{
        "system":{
            "type":"string",
            "minLength":1
        },
        "value":{
            "type":"string",
            "minLength":1
        },
        "use":{
            "type":"string",
            "minLength":1
        }
    }
}