Jump to

• Request
• Response

Get a location by ID

get

/Location/{id}

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

Retrieves an individual location by the associated ID.

Request

Path Parameters

• id(required): string
  The logical resource ID.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.

There's no request body for this operation.

Back to Top

Response

200 Response

Successful retrieve response.

Body ()

Root Schema : Location

Type: object

Show Source

• address: address
  The physical location.
• id(required): string
• managingOrganization: managingOrganization
  The organization responsible for provisioning and upkeep.
• name(required): string
  The name of the location as used by humans.
• resourceType(required): string
  Allowed Values: [ "Location" ]
• status: string
  The following statuses are supported:

  • active
  • suspended
  • inactive
• telecom: array telecom
  The contact details of the location.

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "name"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Location"
            ]
        },
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"The following statuses are supported:\n  <ul>\n    <li><code>active</code></li>\n    <li><code>suspended</code></li>\n    <li><code>inactive</code></li>\n  </ul>\n"
        },
        "name":{
            "type":"string",
            "description":"The name of the location as used by humans."
        },
        "telecom":{
            "type":"array",
            "description":"The contact details of the location.",
            "items":{
                "$ref":"#/components/schemas/ContactPoint"
            }
        },
        "address":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Address"
                }
            ],
            "description":"The physical location."
        },
        "managingOrganization":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"The organization responsible for provisioning and upkeep."
        }
    }
}

Nested Schema : address

The physical location.

Match All

The physical location.

Show Source

• object Address

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Address"
        }
    ],
    "description":"The physical location."
}

Nested Schema : managingOrganization

The organization responsible for provisioning and upkeep.

Match All

The organization responsible for provisioning and upkeep.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"The organization responsible for provisioning and upkeep."
}

Nested Schema : telecom

Type: array

The contact details of the location.

Show Source

• Array of: object ContactPoint

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

Nested Schema : Address

Type: object

Show Source

• city: string
  The name of city, town, and so on.
• country: string
  The country, which can be the International Organization for Standardization (ISO) 3166 two-letter or three-letter code.
• line: array line
  The street name, number, direction, P.O. Box, and so on.
• postalCode: string
  The U.S. ZIP Codes.
• state: string
  The subunit of the country (abbreviations are supported).

{
    "type":"object",
    "properties":{
        "line":{
            "type":"array",
            "description":"The street name, number, direction, P.O. Box, and so on.",
            "items":{
                "type":"string"
            }
        },
        "city":{
            "type":"string",
            "description":"The name of city, town, and so on."
        },
        "state":{
            "type":"string",
            "description":"The subunit of the country (abbreviations are supported)."
        },
        "postalCode":{
            "type":"string",
            "description":"The U.S. ZIP Codes."
        },
        "country":{
            "type":"string",
            "description":"The country, which can be the International Organization for Standardization (ISO) 3166 two-letter or three-letter code."
        }
    }
}

Nested Schema : line

Type: array

The street name, number, direction, P.O. Box, and so on.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The street name, number, direction, P.O. Box, and so on.",
    "items":{
        "type":"string"
    }
}

Nested Schema : Reference

Type: object

Show Source

• reference: string
• type: string

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

Nested Schema : ContactPoint

Type: object

Show Source

• system: string
  (USCDI) The following values are supported:

  • phone
  • fax
  • email
  • pager
  • url
  • sms
  • other
• value: string
  The actual contact point details.

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "description":"(USCDI) The following values are supported:\n  <ul>\n    <li><code>phone</code></li>\n    <li><code>fax</code></li>\n    <li><code>email</code></li>\n    <li><code>pager</code></li>\n    <li><code>url</code></li>\n    <li><code>sms</code></li>\n    <li><code>other</code></li>\n  </ul>\n"
        },
        "value":{
            "type":"string",
            "description":"The actual contact point details."
        }
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

Show Source

• issue(required): array issue
• resourceType(required): string
  Allowed Values: [ "OperationOutcome" ]

{
    "type":"object",
    "required":[
        "resourceType",
        "issue"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ]
        },
        "issue":{
            "type":"array",
            "items":{
                "type":"object",
                "required":[
                    "severity",
                    "code"
                ],
                "properties":{
                    "severity":{
                        "type":"string"
                    },
                    "code":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : issue

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "required":[
            "severity",
            "code"
        ],
        "properties":{
            "severity":{
                "type":"string"
            },
            "code":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• code(required): string
• severity(required): string

{
    "type":"object",
    "required":[
        "severity",
        "code"
    ],
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        }
    }
}

Back to Top