Jump to

• Request
• Response

Get a list of organizations

get

/Organization

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 a list of organizations that meet the supplied query parameters.

Request

Query Parameters

• _id: string
  The logical resource ID.
• address: string
  The organization's address or part of the address.
• name: string
  The organization's name or a portion of the name.

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 search response.

Body ()

Root Schema : schema

Type: object

Show Source

• entry: array entry
• id(required): string
• link: array link
• resourceType(required): string
  Allowed Values: [ "Bundle" ]
• type(required): string

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "type"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Bundle"
            ]
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "link":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundleLink"
            }
        },
        "entry":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "fullUrl":{
                        "type":"string",
                        "format":"uri"
                    },
                    "resource":{
                        "$ref":"#/components/schemas/Organization"
                    },
                    "search":{
                        "$ref":"#/components/schemas/Search"
                    }
                }
            }
        }
    }
}

Nested Schema : entry

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "fullUrl":{
                "type":"string",
                "format":"uri"
            },
            "resource":{
                "$ref":"#/components/schemas/Organization"
            },
            "search":{
                "$ref":"#/components/schemas/Search"
            }
        }
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object BundleLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BundleLink"
    }
}

Nested Schema : items

Type: object

Show Source

• fullUrl: string (uri)
• resource: object Organization
• search: object Search

{
    "type":"object",
    "properties":{
        "fullUrl":{
            "type":"string",
            "format":"uri"
        },
        "resource":{
            "$ref":"#/components/schemas/Organization"
        },
        "search":{
            "$ref":"#/components/schemas/Search"
        }
    }
}

Nested Schema : Organization

Type: object

Show Source

• active(required): boolean
  Whether the organization's record is still in active use.
• address: array address
  An address for the organization.
• id(required): string
• identifier: array identifier
  An identifier for this organization across multiple systems.
• name(required): string
  The name used for the organization.
• resourceType(required): string
  Allowed Values: [ "Organization" ]
• telecom: array telecom
  A contact detail for the organization.

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "active",
        "name"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Organization"
            ]
        },
        "id":{
            "type":"string"
        },
        "identifier":{
            "type":"array",
            "description":"An identifier for this organization across multiple systems.",
            "items":{
                "$ref":"#/components/schemas/Identifier"
            }
        },
        "active":{
            "type":"boolean",
            "description":"Whether the organization's record is still in active use."
        },
        "name":{
            "type":"string",
            "description":"The name used for the organization."
        },
        "telecom":{
            "type":"array",
            "description":"A contact detail for the organization.",
            "items":{
                "$ref":"#/components/schemas/ContactPoint"
            }
        },
        "address":{
            "type":"array",
            "description":"An address for the organization.",
            "items":{
                "$ref":"#/components/schemas/Address"
            }
        }
    }
}

Nested Schema : Search

Type: object

Show Source

• mode: string

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

Nested Schema : address

Type: array

An address for the organization.

Show Source

• Array of: object Address

{
    "type":"array",
    "description":"An address for the organization.",
    "items":{
        "$ref":"#/components/schemas/Address"
    }
}

Nested Schema : identifier

Type: array

An identifier for this organization across multiple systems.

Show Source

• Array of: object Identifier

{
    "type":"array",
    "description":"An identifier for this organization across multiple systems.",
    "items":{
        "$ref":"#/components/schemas/Identifier"
    }
}

Nested Schema : telecom

Type: array

A contact detail for the organization.

Show Source

• Array of: object ContactPoint

{
    "type":"array",
    "description":"A contact detail for the organization.",
    "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 : Identifier

Type: object

Show Source

• system(required): string (uri)
• value(required): string

{
    "type":"object",
    "required":[
        "system",
        "value"
    ],
    "properties":{
        "system":{
            "type":"string",
            "format":"uri"
        },
        "value":{
            "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."
        }
    }
}

Nested Schema : BundleLink

Type: object

Show Source

• relation: string
  Allowed Values: [ "self", "next", "previous" ]
• url: string (uri)

{
    "type":"object",
    "properties":{
        "relation":{
            "type":"string",
            "enum":[
                "self",
                "next",
                "previous"
            ]
        },
        "url":{
            "type":"string",
            "format":"uri"
        }
    }
}

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