Get a list of organizations

get

/Organization

Retrieves a list of organizations that meet supplied query parameters.

Note:

  • Performing an organization search request without any parameters returns all available organizations, paginated.
  • Searching all organizations is not recommended for sites that have a large number of organizations.

Authorization Types

This operation supports the following authorization types:

Request

Query Parameters
  • The maximum number of results to return. Defaults to 100.
  • The logical resource ID.
    Example: _id=doc-1234
  • An address for the organization. All organizations to be returned whose street, name, state, or postal code starts with the given string.
    Example: address=1234
  • The NPI, OID, FederalTAXID, or other identifier for the organization.
    • Code details are required.
      • NPI, OID, FederalTAXID: A system is optional. If a system is not provided, the search is performed across all systems supported by the Organization resource.
      • Other Identifiers: When searching by a cernerSystem, system and value are both required for search.
    • When a valid system is provided, the search is performed against the specific system.
    • When an invalid system is provided, a 400 (Bad Request) status code is returned.
    Example: identifier=123456789
  • The name used for the organization.
    Example: name=aaaaaaa
  • The organization's type. Searching with proprietary codes or systems is not supported.
    Example:
    http://terminology.hl7.org/CodeSystem/organization-type|govt
Header Parameters
Back to Top

Response

Supported Media Types

Default Response

Example search by _id.
Example Request:
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Organization?_id=675844
Example Response:
{
    'resourceType': 'Bundle',
    'id': '572dbd7f-2505-41cd-a9ac-240db77545a1',
    'type': 'searchset',
    'total': 1,
    'link': [
      {
        'relation': 'self',
        'url': 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Organization?_id=675844'
      }
    ],
    'entry': [
      {
        'fullUrl': 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Organization/675844',
        'resource': {
          'resourceType': 'Organization',
          'id': '675844',
          'meta': {
            'versionId': '29',
            'lastUpdated': '2018-05-22T16:46:28Z'
          },
          'text': {
            'status': 'generated',
            'div': '<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Organization</b></p><p><b>Name</b>: Model Hospital</p><p><b>Status</b>: Active</p><p><b>TAXID</b>: 123456785</p></div>'
          },
          'identifier': [
            {
              'use': 'official',
              'type': {
                'coding': [
                  {
                    'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/334',
                    'code': 'TAXID',
                    'display': 'zzTax Identifier',
                    'userSelected': true
                  },
                  {
                    'system': 'http://terminology.hl7.org/CodeSystem/v2-0203',
                    'code': 'TAX',
                    'display': 'Tax ID number'
                  }
                ],
                'text': 'zzTax Identifier'
              },
              'system': 'urn:oid:2.16.840.1.113883.4.4',
              'value': '123456785'
            }
          ],
          'active': true,
          'type': [
            {
              'coding': [
                {
                  'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/278',
                  'code': 'EMPLOYER',
                  'display': 'Employer',
                  'userSelected': true
                }
              ],
              'text': 'Employer'
            },
            {
              'coding': [
                {
                  'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/278',
                  'code': 'PLACEOFSVC',
                  'display': 'Place of Service',
                  'userSelected': true
                },
                {
                  'system': 'http://terminology.hl7.org/CodeSystem/organization-type',
                  'code': 'prov',
                  'display': 'Healthcare Provider'
                }
              ],
              'text': 'Place of Service'
            },
            {
              'coding': [
                {
                  'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/278',
                  'code': 'CLIENT',
                  'display': 'Client',
                  'userSelected': true
                }
              ],
              'text': 'Client'
            },
            {
              'coding': [
                {
                  'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/278',
                  'code': 'LABORATORY',
                  'display': 'Exchange Lab',
                  'userSelected': true
                }
              ],
              'text': 'Exchange Lab'
            },
            {
              'coding': [
                {
                  'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/278',
                  'code': 'FACILITY',
                  'display': 'Facility',
                  'userSelected': true
                }
              ],
              'text': 'Facility'
            }
          ],
          'name': 'Model Hospital',
          'telecom': [
            {
              'system': 'phone',
              'value': '5555550013',
              'use': 'work'
            }
          ],
          'address': [
            {
              'use': 'work',
              'text': '6276 Rockriver Drive\nKansas City, MO 64117\nUS',
              'line': [
                '6276 Rockriver Drive'
              ],
              'city': 'Kansas City',
              'state': 'MO',
              'postalCode': '64117',
              'country': 'US'
            },
            {
              'use': 'billing',
              'text': '6276 Rockriver Drive\nKansas City, MO 64117\nUS',
              'line': [
                '6276 Rockriver Drive'
              ],
              'city': 'Kansas City',
              'state': 'MO',
              'postalCode': '64117',
              'country': 'US'
            },
            {
              'use': 'billing',
              'text': '6276 Rockriver Drive\nKansas City, MO 64117\nUS',
              'line': [
                '6276 Rockriver Drive'
              ],
              'city': 'Kansas City',
              'state': 'MO',
              'postalCode': '64117',
              'country': 'US'
            },
            {
              'text': '6276 Rockriver Drive\nKansas City, MO 64117\nUS',
              'line': [
                '6276 Rockriver Drive'
              ],
              'city': 'Kansas City',
              'state': 'MO',
              'postalCode': '64117',
              'country': 'US'
            },
            {
              'text': '6276 Rockriver Drive\nKansas City, MO 64117\nUS',
              'line': [
                '6276 Rockriver Drive'
              ],
              'city': 'Kansas City',
              'state': 'MO',
              'postalCode': '64117',
              'country': 'US'
            }
          ]
        }
      }
    ]
  }
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.
Back to Top