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.

_search

Query for organization records.

This is a flexible option with query 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.

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

    • resource
      required, object

      A grouping of people or organizations with a common purpose

      • resourceType
        required, string

        Identifies the type of the resource

        Value: Organization
      • active
        required, boolean

        Whether the organization's record is still in active use.

      • name
        required, string

        A name associated with the organization.

      • id
        string

        The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

      • identifier
        Array of NPI or Other

        Identifier for the organization that is used to identify the organization across multiple disparate systems.

        • system
          required, string

          Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

          Value: http://hl7.org/fhir/sid/us-npi
        • extension
          Array of Boolean, String, CodeableConcept, Coding, HumanName or Reference

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          • url
            required, string

            Source of the definition for the extension code - a logical name or a URL.

          • valueBoolean
            boolean

            A single value for the extension.

        • use
          string

          The purpose of this identifier.

          Possible Values: usual, official, temp, secondary, old (If known)
        • value
          string

          The portion of the identifier typically relevant to the user and which is unique within the context of the system.

      • type
        Array of object

        The kind(s) of organization that this is.

        • coding
          Array of object

          A reference to a code defined by a terminology system.

          • system
            string

            The identification of the code system that defines the meaning of the symbol in the code.

          • code
            string

            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

        • text
          string

          A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

      • telecom
        Array of object

        A contact detail for the organization.

        • system
          string

          Telecommunications form for contact point - what communications system is required to make use of the contact.

          Possible Values: phone, fax, email, pager, url, sms, other
        • value
          string

          The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

        • use
          string

          Identifies the purpose for the contact point.

          Possible Values: home, work, temp, old, mobile
      • address
        Array of object

        An address for the organization.

        • line
          Array of string

          This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

        • city
          string

          The name of the city, town, suburb, village or other community or delivery center.

        • state
          string

          Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

        • postalCode
          string

          A postal code designating a region defined by the postal service.

        • country
          string

          Country - a nation as commonly understood or generally accepted.

        • use
          string

          The purpose of this address.

          Possible Values: home, work, temp, old, billing
        • district
          string

          The name of the administrative area (county).

      • partOf
        object

        The organization of which this organization forms a part.

        Must be a resource of type Organization.

        • reference
          string

          A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

    • search
      required, object

      Information about the search process that lead to the creation of this entry.

      • mode
        required, string

        Identifies the Organization as matching the search parameters

        Value: match