Organization _search

post/Organization/_search

Page View

This resource defines a group of individuals or clinicians that form an organization of some kind. An organization record may consist of multiple organizations, like an umbrella healthcare organization with multiple physical locations.

You can review, retrieve, create, or update organization records.

Supported fields and schema examples

We support any valid FHIR® field. However, we only display fields we’ve defined in our schema, which are usually based on what’s included in the U.S. Core profile. We recommend relying on U.S. Core requirements.

Our schema examples show the shape and possibility of each FHIR® resource; they aren’t code for real-time API calls. We don’t currently recommend copying and pasting these schema examples for your API calls. Consider reviewing FHIR® API actions for realistic examples for particular use cases.

_search

Query for organization records.

Flexible FHIR queries, different query parameters

FHIR® queries are a flexible option with parameters to refine your search. The response returns a bundle of resources, known as a searchset bundle type. Learn about bundles and bundle types in our FHIR® glossary.

We only note which query parameters are required if you're querying a FHIR® server directly. Remember that Redox (i.e., data on demand) isn't a FHIR® server, and your connection may not be either.

Query parameters will vary between sites. Work with your connection to find out which query parameters they require for a successful search.

Request parameters and payload

cURL request example

bash

1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/Organization/_search' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/x-www-form-urlencoded' \
5
--data-urlencode 'name=string' \
6
--data-urlencode 'address-city=string' \
7
--data-urlencode 'address-state=string' \
8
--data-urlencode 'address-postalcode=string' \
9
--data-urlencode 'name-searchtype=string' \
10
--data-urlencode 'radius=string' \
11
--data-urlencode 'index=string' \
12
--data-urlencode 'limit=string' \
13
--data-urlencode 'active=string'

Request Body Schema

name
Array of string
The name of the organization
address-city
Array of string
A city specified in an address
address-state
Array of string
A state specified in an address
address-postalcode
Array of string
A postalCode (in the US, a ZIP code) specified in an address
name-searchtype
Array of string
NameSearch type - exact or partOf
radius
Array of string
The radius, in miles, to search for organizations around the provided ZipCode.
index
Array of string
The index to return results starting from. Used for paged results
limit
Array of string
The maximum results you want in the response. default: 500
active
Array of string
If organization is considered active. If true, only active organizations will be returned, default is true.

Response fields and example

Example payload generated from schema

1
{
2
  "resourceType": "Bundle",
3
  "type": "searchset",
4
  "total": 1,
5
  "entry": [
6
    {
7
      "resource": {
8
        "resourceType": "Organization",
9
        "id": "86336b7d-af6c-3f75-b2f5-7437732b471d",
10
        "extension": [
11
          {
12
            "url": "http://synthetichealth.github.io/synthea/utilization-encounters-extension",
13
            "valueInteger": 507
14
          },
15
          {
16
            "url": "http://synthetichealth.github.io/synthea/utilization-procedures-extension",
17
            "valueInteger": 0
18
          },
19
          {
20
            "url": "http://synthetichealth.github.io/synthea/utilization-labs-extension",
21
            "valueInteger": 0
22
          },
23
          {
24
            "url": "http://synthetichealth.github.io/synthea/utilization-prescriptions-extension",
25
            "valueInteger": 0
26
          }
27
        ],
28
        "identifier": [
29
          {
30
            "system": "https://github.com/synthetichealth/synthea",
31
            "value": "86336b7d-af6c-3f75-b2f5-7437732b471d"
32
          }
33
        ],
34
        "active": true,
35
        "type": [
36
          {
37
            "coding": [
38
              {
39
                "code": "prov",
40
                "system": "http://terminology.hl7.org/CodeSystem/organization-type",
41
                "display": "Healthcare Provider"
42
              }
43
            ],
44
            "text": "Healthcare Provider"
45
          }
46
        ],
47
        "name": "HSHS ST CLARE MEMORIAL HOSPITAL",
48
        "telecom": [
49
          {
50
            "system": "phone",
51
            "value": "9208463444"
52
          }
53
        ],
54
        "address": [
55
          {
56
            "line": [
57
              "855 S MAIN ST"
58
            ],
59
            "city": "OCONTO FALLS",
60
            "state": "WI",
61
            "postalCode": "541541282",
62
            "country": "US"
63
          }
64
        ]
65
      },
66
      "search": {
67
        "mode": "match"
68
      }
69
    }
70
  ]
71
}

Response to an Organization search operation

resourceType
required, string
Identifies the type of the resource
Value: Bundle
type
required, string
Identifies this bundle as a response to a search
Value: searchset
total
required, number
The total number of matches
entry
Array of Organization or Other
A resource matching the search criteria or related to a matching resource

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.