Jump to

• Request
• Response

Get a list of locations

get

/Location

Note: The FHIR API endpoints described below are available for customers to deploy and use. Developers are welcome and encouraged to develop against the specifications in anticipation of customer deployment.

Retrieves a list of locations that meet the supplied query parameters.

• Provide at least one of _id, name, or address.
• Do not combine _id with name or address.

Request

Query Parameters

• _id: string
  The logical resource ID.
• _revinclude: string
  The inclusion of related Provenance resources.

  Allowed Values: [ "Provenance:target" ]
• address: string
  The location address text.
• name: string
  The location name text.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The OAuth 2.0 Bearer token used to authenticate the request.

There's no request body for this operation.

Back to Top

Response

200 Response

The successful search response.

Body ()

Root Schema : schema

Type: object

Show Source

• entry: array entry
• id(required): string
• link: array link
• resourceType(required): string
  Allowed Values: [ "Bundle" ]
• type(required): string

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "type"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Bundle"
            ]
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "link":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundleLink"
            }
        },
        "entry":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundleEntryForLocation"
            }
        }
    }
}

Nested Schema : entry

Type: array

Show Source

• Array of: object BundleEntryForLocation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BundleEntryForLocation"
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object BundleLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BundleLink"
    }
}

Nested Schema : BundleEntryForLocation

Type: object

Show Source

• fullUrl: string
  The resource URL.
• resource: object Location
  A physical place where healthcare services are provided.
• search: object BundleEntrySearch

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "fullUrl":{
            "type":"string",
            "description":"The resource URL."
        },
        "resource":{
            "$ref":"#/components/schemas/Location"
        },
        "search":{
            "$ref":"#/components/schemas/BundleEntrySearch"
        }
    }
}

Nested Schema : Location

Type: object

A physical place where healthcare services are provided.

Show Source

• _name: object PrimitiveElement
• address: array address
  The physical address details.
• id(required): string
  The logical ID of the location.
• managingOrganization: object ReferenceForLocation
• name(required): string
  The human-readable name of the location.
• resourceType(required): string
  Allowed Values: [ "Location" ]
• status: string
  Allowed Values: [ "active", "suspended", "inactive" ]

  Whether the location is in use.
• telecom: array telecom
  The contact details for the location.

{
    "type":"object",
    "description":"A physical place where healthcare services are provided.",
    "required":[
        "resourceType",
        "id",
        "name"
    ],
    "additionalProperties":false,
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Location"
            ]
        },
        "id":{
            "type":"string",
            "description":"The logical ID of the location."
        },
        "status":{
            "type":"string",
            "enum":[
                "active",
                "suspended",
                "inactive"
            ],
            "description":"Whether the location is in use."
        },
        "name":{
            "type":"string",
            "description":"The human-readable name of the location."
        },
        "_name":{
            "$ref":"#/components/schemas/PrimitiveElement"
        },
        "managingOrganization":{
            "$ref":"#/components/schemas/ReferenceForLocation"
        },
        "telecom":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContactPoint"
            },
            "description":"The contact details for the location."
        },
        "address":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Address"
            },
            "description":"The physical address details."
        }
    }
}

Nested Schema : BundleEntrySearch

Type: object

Show Source

• mode: string

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

Nested Schema : PrimitiveElement

Type: object

Show Source

• extension: array extension

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Extension"
            }
        }
    }
}

Nested Schema : address

Type: array

The physical address details.

Show Source

• Array of: object Address

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Address"
    },
    "description":"The physical address details."
}

Nested Schema : ReferenceForLocation

Type: object

Show Source

• reference(required): string
  The relative organization reference.

{
    "type":"object",
    "additionalProperties":false,
    "required":[
        "reference"
    ],
    "properties":{
        "reference":{
            "type":"string",
            "description":"The relative organization reference."
        }
    }
}

Nested Schema : telecom

Type: array

The contact details for the location.

Show Source

• Array of: object ContactPoint

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContactPoint"
    },
    "description":"The contact details for the location."
}

Nested Schema : extension

Type: array

Show Source

• Array of: object Extension

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Extension"
    }
}

Nested Schema : Extension

Type: object

Show Source

• url: string (uri)
• valueCode: string

{
    "type":"object",
    "properties":{
        "url":{
            "type":"string",
            "format":"uri"
        },
        "valueCode":{
            "type":"string"
        }
    }
}

Nested Schema : Address

Type: object

Show Source

• city: string
• country: string
• district: string
• line: array line
• period: object Period
• postalCode: string
• state: string
• text: string
• type: string
• use: string

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "use":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "text":{
            "type":"string"
        },
        "line":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "city":{
            "type":"string"
        },
        "district":{
            "type":"string"
        },
        "state":{
            "type":"string"
        },
        "postalCode":{
            "type":"string"
        },
        "country":{
            "type":"string"
        },
        "period":{
            "$ref":"#/components/schemas/Period"
        }
    }
}

Nested Schema : line

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : Period

Type: object

Show Source

• end: string
• start: string

{
    "type":"object",
    "properties":{
        "start":{
            "type":"string"
        },
        "end":{
            "type":"string"
        }
    }
}

Nested Schema : ContactPoint

Type: object

Show Source

• period: object Period
• rank: integer
• system: string
  The telecommunications form.
• use: string
• value: string
  The contact value.

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "description":"The telecommunications form."
        },
        "value":{
            "type":"string",
            "description":"The contact value."
        },
        "use":{
            "type":"string"
        },
        "rank":{
            "type":"integer"
        },
        "period":{
            "$ref":"#/components/schemas/Period"
        }
    }
}

Nested Schema : BundleLink

Type: object

Show Source

• relation: string
  Allowed Values: [ "self", "next", "previous" ]

  The link relation.
• url: string
  The link URL.

{
    "type":"object",
    "properties":{
        "relation":{
            "type":"string",
            "enum":[
                "self",
                "next",
                "previous"
            ],
            "description":"The link relation."
        },
        "url":{
            "type":"string",
            "description":"The link URL."
        }
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

The FHIR OperationOutcome.

Show Source

• issue: array issue
  The OperationOutcome issues.
• resourceType: string
  Allowed Values: [ "OperationOutcome" ]

  The FHIR resource type.

{
    "type":"object",
    "description":"The FHIR OperationOutcome.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ],
            "description":"The FHIR resource type."
        },
        "issue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OperationOutcomeIssue"
            },
            "description":"The OperationOutcome issues."
        }
    }
}

Nested Schema : issue

Type: array

The OperationOutcome issues.

Show Source

• Array of: object OperationOutcomeIssue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OperationOutcomeIssue"
    },
    "description":"The OperationOutcome issues."
}

Nested Schema : OperationOutcomeIssue

Type: object

Show Source

• code: string
• details: object CodeableConcept
• diagnostics: string
• expression: array expression
• severity: string

{
    "type":"object",
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "details":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "diagnostics":{
            "type":"string"
        },
        "expression":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : expression

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Back to Top