FHIR R4 APIs for Oracle Health Millennium Platform

Get a list of locations

get

/Location

Retrieves a list of locations that meet supplied query parameters.

Request

Query Parameters

-physicalType: string
The location's physical type. Searching by Millennium proprietary codes is not supported. This parameter is required if the _id parameter is not used.
Example:
```
http://terminology.hl7.org/CodeSystem/location-physical-type|ro
```
_count: string

The maximum number of results to return.
Default: 100
_id: string

The logical resource ID. This parameter is required if the -physicalType parameter is not used.
address: string

Part of the location's address.
Example: 123%20Main
address-city: string

The city specified in the address. Must include the address-state or address-postalcode parameter.
Example: Kansas
address-postalcode: string

The postal code specified in the address.
Example: 64111
address-state: string

The state specified in the address.
Example: MO
identifier: string

The location's identifier.
Example: 653385|FSI^~BUILD^~NU
name: string

The portion of the location's name or alias. Must include any of the following parameters: -physicalType, identifier, address, address-state, address-city, or address-postalcode.
Example: Main
organization: string

The organization that manages the location. Must include any of the following parameters: -physicalType, identifier, address, address-state, address-city, or address-postalcode.
Example: 675844

Header Parameters

accept(required): string

The media type to be requested. See what the resource's operation produces for what is supported.

Response

Supported Media Types

application/json+fhir

Default Response

This operation supports the following authorization types:

Example Request:

GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?_id=21250409

Example Response:

{
  "resourceType": "Bundle",
  "id": "902e1b49-b9c4-4786-b90b-c9612d478f2a",
  "type": "searchset",
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?_id=21250409"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location/21250409",
      "resource": {
        "resourceType": "Location",
        "id": "21250409",
        "meta": {
          "versionId": "6",
          "lastUpdated": "2018-06-12T18:45:00Z"
        },
        "text": {
          "status": "generated",
          "div": "Location
Name: BE 1 North
Alias: BE 1N
Managing Organization: Baseline East Medical Center
Part Of: 21250403
Physical Type: Facility(s)
Status: Active"
        },
        "extension": [
          {
            "extension": [
              {
                "id": "20356268",
                "valueString": "Core Measure Locations",
                "url": "custom-attribute-name"
              },
              {
                "valueCodeableConcept": {
                  "coding": [
                    {
                      "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4678015",
                      "code": "20140683",
                      "display": "ED",
                      "userSelected": true
                    }
                  ],
                  "text": "ED"
                },
                "url": "custom-attribute-value"
              }
            ],
            "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/custom-attribute"
          }
        ],
        "identifier": [
          {
            "use": "official",
            "type": {
              "coding": [
                {
                  "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/73",
                  "code": "ACCTRECEIVABLE",
                  "display": "FIN NBR",
                  "userSelected": true
                }
              ]
            },
            "system": "FIN NBR",
            "value": "16000"
          }
        ],
        "status": "active",
        "name": "BE 1 North",
        "alias": [
          "BE 1N"
        ],
        "mode": "instance",
        "address": {
          "text": "Cerner H2 building\nLevel 4\nManyata embassy business park\nNagawara cicle\nBangalore, AA \nIreland",
          "line": [
            "Cerner H2 building",
            "Level 4",
            "Manyata embassy business park",
            "Nagawara cicle"
          ],
          "city": "Bangalore",
          "district": "Indian River",
          "state": "AA",
          "country": "Ireland"
        },
        "physicalType": {
          "coding": [
            {
              "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/222",
              "code": "783",
              "display": "Facility(s)",
              "userSelected": true
            }
          ],
          "text": "Facility(s)"
        },
        "managingOrganization": {
          "reference": "Organization/13971625",
          "display": "Baseline East Medical Center"
        },
        "partOf": {
          "reference": "Location/21250403"
        }
      }
    }
  ]
}

Headers

X-Request-Id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.

x-address Response

This operation supports the following authorization types:

Example Request:

GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?address=MO

Example Response:

{
  "resourceType": "Bundle",
  "id": "d7638736-7e04-4e36-9fd1-357159396499",
  "type": "searchset",
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?address=MO"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?address=MO",
      "resource": {
        "fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location/20573078",
        "resource": {
          "resourceType": "Location",
          "id": "20573078",
          "meta": {
            "versionId": "20",
            "lastUpdated": "2018-05-22T16:42:00Z"
          },
          "text": {
            "status": "generated",
            "div": "Location
Name: Model Behavioral Health Clinic
Alias: MX BH CL
Managing Organization: Model Behavioral Health Clinic
Physical Type: Facility(s)
Status: Active"
          },
          "status": "active",
          "name": "Model Behavioral Health Clinic",
          "alias": [
            "MX BH CL"
          ],
          "mode": "instance",
          "telecom": [
            {
              "system": "phone",
              "value": "555 555 0001"
            }
          ],
          "address": {
            "use": "work",
            "text": "1234 Main\\nKansas City, MO 64111\\nUS",
            "line": [
              "1234 Main"
            ],
            "city": "Kansas City",
            "state": "MO",
            "postalCode": "64111",
            "country": "US"
          },
          "physicalType": {
            "coding": [
              {
                "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/222",
                "code": "783",
                "display": "Facility(s)",
                "userSelected": true
              },
              {
                "system": "http://terminology.hl7.org/CodeSystem/location-physical-type",
                "code": "si",
                "display": "Site"
              }
            ],
            "text": "Facility(s)"
          },
          "managingOrganization": {
            "reference": "Organization/667844",
            "display": "Model Behavioral Health Clinic"
          }
        }
      }
    }
  ]
}

x-address_city_state Response

This operation supports the following authorization types:

Example Request:

GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?address-state=MO&address-city=Kansas

Example Response:

{
  "resourceType": "Bundle",
  "id": "418d018e-ef93-43a0-b880-4888218ed3c6",
  "type": "searchset",
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?address-state=MO&address-city=Kansas"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?address-state=MO&address-city=Kansas",
      "resource": {
        "fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location/20573078",
        "resource": {
          "resourceType": "Location",
          "id": "20573078",
          "meta": {
            "versionId": "20",
            "lastUpdated": "2018-05-22T16:42:00Z"
          },
          "text": {
            "status": "generated",
            "div": "Location
Name: Model Behavioral Health Clinic
Alias: MX BH CL
Managing Organization: Model Behavioral Health Clinic
Physical Type: Facility(s)
Status: Active"
          },
          "status": "active",
          "name": "Model Behavioral Health Clinic",
          "alias": [
            "MX BH CL"
          ],
          "mode": "instance",
          "telecom": [
            {
              "system": "phone",
              "value": "555 555 0001"
            }
          ],
          "address": {
            "use": "work",
            "text": "1234 Main\\nKansas City, MO 64111\\nUS",
            "line": [
              "1234 Main"
            ],
            "city": "Kansas City",
            "state": "MO",
            "postalCode": "64111",
            "country": "US"
          },
          "physicalType": {
            "coding": [
              {
                "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/222",
                "code": "783",
                "display": "Facility(s)",
                "userSelected": true
              },
              {
                "system": "http://terminology.hl7.org/CodeSystem/location-physical-type",
                "code": "si",
                "display": "Site"
              }
            ],
            "text": "Facility(s)"
          },
          "managingOrganization": {
            "reference": "Organization/667844",
            "display": "Model Behavioral Health Clinic"
          }
        }
      }
    }
  ]
}

x-identifier Response

This operation supports the following authorization types:

Example Request:

GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?identifier=653385|FSI^~BUILD^~NU

Example Response:

{
  "resourceType": "Bundle",
  "id": "902e1b49-b9c4-4786-b90b-c9612d478f2a",
  "type": "searchset",
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?_id=21250409"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location/21250409",
      "resource": {
        "resourceType": "Location",
        "id": "21250409",
        "meta": {
          "versionId": "6",
          "lastUpdated": "2018-06-12T18:45:00Z"
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Location</b></p><p><b>Name</b>: BE 1 North</p><p><b>Alias</b>: BE 1N</p><p><b>Managing Organization</b>: Baseline East Medical Center</p><p><b>Part Of</b>: 21250403</p><p><b>Physical Type</b>: Facility(s)</p><p><b>Status</b>: Active</p></div>"
        },
        "extension": [
          {
            "extension": [
              {
                "id": "20356268",
                "valueString": "Core Measure Locations",
                "url": "custom-attribute-name"
              },
              {
                "valueCodeableConcept": {
                  "coding": [
                    {
                      "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4678015",
                      "code": "20140683",
                      "display": "ED",
                      "userSelected": true
                    }
                  ],
                  "text": "ED"
                },
                "url": "custom-attribute-value"
              }
            ],
            "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/custom-attribute"
          }
        ],
        "identifier": [
          {
            "use": "official",
            "type": {
              "coding": [
                {
                  "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/73",
                  "code": "ACCTRECEIVABLE",
                  "display": "FIN NBR",
                  "userSelected": true
                }
              ]
            },
            "system": "FIN NBR",
            "value": "16000"
          }
        ],
        "status": "active",
        "name": "BE 1 North",
        "alias": [
          "BE 1N"
        ],
        "mode": "instance",
        "address": {
          "text": "Cerner H2 building\nLevel 4\nManyata embassy business park\nNagawara cicle\nBangalore, AA \nIreland",
          "line": [
            "Cerner H2 building",
            "Level 4",
            "Manyata embassy business park",
            "Nagawara cicle"
          ],
          "city": "Bangalore",
          "district": "Indian River",
          "state": "AA",
          "country": "Ireland"
        },
        "physicalType": {
          "coding": [
            {
              "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/222",
              "code": "783",
              "display": "Facility(s)",
              "userSelected": true
            }
          ],
          "text": "Facility(s)"
        },
        "managingOrganization": {
          "reference": "Organization/13971625",
          "display": "Baseline East Medical Center"
        },
        "partOf": {
          "reference": "Location/21250403"
        }
      }
    }
  ]
}

Headers

X-Request-Id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.

x-name Response

This operation supports the following authorization types:

Example Request:

GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?address=kansas&name=ABC

Example Response:

{
  "resourceType": "Bundle",
  "id": "af79f094-3b5e-4472-86bf-4044aeb4193c",
  "type": "searchset",
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?address=kansas&name=ABC"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location/2554914033",
      "resource": {
        "resourceType": "Location",
        "id": "2554914033",
        "meta": {
          "versionId": "0",
          "lastUpdated": "2017-09-19T17:38:08Z"
        },
        "text": {
          "status": "generated",
          "div": "Location
 Name: ABC Taxi Company
Alias: ABC Taxi
Managing Organization: ABC Taxi Company
 Physical Type: Facility(s)
Status: Active"
        },
        "identifier": [
          {
            "use": "official",
            "type": {
              "coding": [
                {
                  "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/73",
                  "code": "ACCTRECEIVABLE",
                  "display": "FIN NBR",
                  "userSelected": true
                }
              ]
            },
            "system": "FIN NBR",
            "value": "16000"
          }
        ],
        "status": "active",
        "name": "ABC Taxi Company",
        "alias": [
          "ABC Taxi"
        ],
        "mode": "instance",
        "telecom": [
          {
            "system": "phone",
            "value": "8168769999"
          }
        ],
        "address": {
          "use": "work",
          "text": "123 Main Street\nKansas City, MO 64117\nUS",
          "line": [
            "123 Main Street"
          ],
          "city": "Kansas City",
          "state": "MO",
          "postalCode": "64117",
          "country": "US"
        },
        "physicalType": {
          "coding": [
            {
              "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/222",
              "code": "783",
              "display": "Facility(s)",
              "userSelected": true
            },
            {
              "system": "http://terminology.hl7.org/CodeSystem/location-physical-type",
              "code": "si",
              "display": "Site"
            }
          ],
          "text": "Facility(s)"
        },
        "managingOrganization": {
          "reference": "Organization/3054032",
          "display": "ABC Taxi Company"
        }
      }
    }
  ]
}

x-organization Response

This operation supports the following authorization types:

Example Request:

GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?address=kansas&organization=667844

Example Response:

{
  "resourceType": "Bundle",
  "id": "a05b2157-824e-4908-b94e-f4617d6ab95e",
  "type": "searchset",
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?address=kansas&organization=667844"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location/20573078",
      "resource": {
        "fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location/20573078",
        "resource": {
          "resourceType": "Location",
          "id": "20573078",
          "meta": {
            "versionId": "20",
            "lastUpdated": "2018-05-22T16:42:00Z"
          },
          "text": {
            "status": "generated",
            "div": "Location
Name: Model Behavioral Health Clinic
Alias: MX BH CL
Managing Organization: Model Behavioral Health Clinic
Physical Type: Facility(s)
Status: Active"
          },
          "status": "active",
          "name": "Model Behavioral Health Clinic",
          "alias": [
            "MX BH CL"
          ],
          "mode": "instance",
          "telecom": [
            {
              "system": "phone",
              "value": "555 555 0001"
            }
          ],
          "address": {
            "use": "work",
            "text": "1234 Main\\nKansas City, MO 64111\\nUS",
            "line": [
              "1234 Main"
            ],
            "city": "Kansas City",
            "state": "MO",
            "postalCode": "64111",
            "country": "US"
          },
          "physicalType": {
            "coding": [
              {
                "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/222",
                "code": "783",
                "display": "Facility(s)",
                "userSelected": true
              },
              {
                "system": "http://terminology.hl7.org/CodeSystem/location-physical-type",
                "code": "si",
                "display": "Site"
              }
            ],
            "text": "Facility(s)"
          },
          "managingOrganization": {
            "reference": "Organization/667844",
            "display": "Model Behavioral Health Clinic"
          }
        }
      }
    }
  ]
}