FHIR Organization

Name:

active

optional

Type:

query

Data Type:

string

Description:

Filters organizations to include those that are currently active or inactive, identified by Organization.active. The possible values for this search parameter can only be one of:

• true
• false

Sample Value: true

Name:

address

optional

Type:

query

Data Type:

array

Description:

Filters the organizations to those that their address is matching the requested address, identified by Organization.address.

Note: Supports passing in a comma-separated list of values.

Sample Value: Main St, Grafton Road

Name:

address-city

optional

Type:

query

Data Type:

array

Description:

Filters the organizations to those that their address city is matching the requested address-city, identified by Organization.address.city.

Note: Supports passing in a comma-separated list of values.

Sample Value: San Diego, Nashville

Name:

address-country

optional

Type:

query

Data Type:

array

Description:

Filters the organizations to those that their address country is matching the requested address-country, identified by Organization.address.country.

Note: Supports passing in a comma-separated list of values.

Sample Value: United States, Canada, New Zealand

Name:

address-postalcode

optional

Type:

query

Data Type:

array

Description:

Filters the organizations to those that their address postal code is matching the requested address-postalcode, identified by Organization.address.postalCode.

Note: Supports passing in a comma-separated list of values.

Sample Value: 10004, 10020

Name:

address-state

optional

Type:

query

Data Type:

array

Description:

Filters the organizations to those that their address state is matching the requested address-state identified by Organization.address.state.

Note: Supports passing in a comma-separated list of values.

Sample Value: California,Ohio,Georgia

Name:

address-use

optional

Type:

query

Data Type:

array

Description:

Filters the organizations to those that match the specified address-use, identified by Organization.address.use. Possible values are:

• home
• work
• temp
• old

• billing

  Note:

  • if an address use system is specified, only http://hl7.org/fhir/address-use can be used.
  • Supports passing in a comma-separated list of values.

Sample Value: home,work

Name:

endpoint

optional

Type:

query

Data Type:

array

Description:

Filters the organizations to those that match the specified endpoint references, identified by Organization.endpoint.

Note: the endpoint can be chained to define filters on the reference endpoint, each of the chained parameters can specify multiple comma separated values.

Sample Value: endpoint.name=Questionnaire Destination&endpoint.status=active&endpoint.connection-type=http://terminology.hl7.org/CodeSystem/endpoint-connection-type|ihe-xcpd

Name:

identifier

optional

Type:

query

Data Type:

array

Description:

Filters the organizations to those that have identifiers that match at least one of the specified identifiers.

Note: The identifier can be a single item or a comma separated list of identifiers. Each identifier is defined by system and value , separated using a URL encoded | character i.e. %7c.

Sample Value: http://hl7.org/fhir/sid/us-npi|1234567890, urn:text:sysA|org345"

Name:

name

optional

Type:

query

Data Type:

array

Description:

Filters the organizations to those that have a matching Location.name or Location.alias. The search for name allows partial matches, is case insensitive and can match any one of the specified names.

Note: Supports passing in a comma-separated list of values.

Sample Value: Metro City Neurology Department

Name:

partof

optional

Type:

query

Data Type:

array

Description:

Filters the organizations to those that form a part of the specified referenced organization,identified by Organization.partOf.

Note: partof can be chained to define filter on the reference organization, each of the chained organization can specify multiple comma separated values.

Sample Value: partof.active=true&partof.type=http://terminology.hl7.org/CodeSystem/organization-type|prov&partof.address=123 Main St Suite 200 Anytown CA 12345 USA

Name:

phonetic

optional

Type:

query

Data Type:

array

Description:

Filters the organizations by giving a portion of the organization's name using some phonetic matching algorithm.

Note: Supports passing in a comma-separated list of values.

Sample Value: UMC Cardiology unit

Name:

type

optional

Type:

query

Data Type:

array

Description:

Filters the organizations to those that match the specified type. The type value consists of a coding system and a code separated using a URL encoded | character i.e. %7c.

Note: Supports passing in a comma-separated list of values.

Sample Value: http://terminology.hl7.org/CodeSystem/organization-type|prov

Name:

organization-location

optional

Type:

query

Data Type:

array

Description:

Filters the organizations to those to a Location reference (plannet-Location) defining the coverage area of a health insurance provider network.

Note:

• This is a pdex-plan-net search parameter for health insurance provider network that match the Organization.extension.where(url='http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/location-reference).

• The organization-location can be chained to define filters on the reference Location, each of the chained parameters can specify multiple comma separated values.

Sample Value: organization-location.identifier=SYS_A|L1

Name:

_lastUpdated

optional

Type:

query

Data Type:

array

Description:

Allows the user to filter organizations by the lastUpdated date. The date value can be a single date, as well as lower and/or upper bound.

The supported operations are: =gt, =ge, =lt, =ne, =le, =eq. For more information about using these search operators, refer to the date section on the FHIR Search page.

The {dateTimeValue} value should be in the following format: 2013-01-01T23:00:00-05:00. However, the time portion can be excluded. If a time portion is provided, the time zone must be provided as well.

It is highly recommended to provide the time zone portion in any query. Ensure that special characters such as '+' are encoded so that it can be interpreted correctly. For example: "2014-01-01T00:00:00+13:00" should be encoded like this: "2014-01-01T00:00:00%2B13:00".

If a date query comes in without a time zone, the date will be interpreted according to the server's time zone.

Including this query parameter includes all Organizations that match the specified Organization.meta.lastUpdated.

Sample Value: _lastUpdated=gt2012-01-01

Name:

_summary

optional

Type:

query

Data Type:

string

Description:

Instructs the server to return a subset of the resource, reducing the size of the reponse payload. Possible values are

• true: return summaries only
• false: return full resources
• count: return the count of search matches
• text: return only the text, id, meta, and top-level mandatory elements
• data: remove the text element

Sample Value: true

Name:

-include-sources

optional

Type:

query

Data Type:

array

Description:

The -include-sources parameter defines which sources should be queried for the results.

Note: Either -include-sources or -exclude-sources parameter can be specified, not both. If -include-sources is specified, ONLY the specified sources will be searched. Note that the sources specified should be enabled.

Sample Value: Orion%20Health%E2%84%A2%20R4%20C-CDA%20Results%20Organizations

Name:

-exclude-sources

optional

Type:

query

Data Type:

array

Description:

The -exclude-sources parameter defines which sources should NOT be queried for the results.

Note: Either -include-sources or -exclude-sources parameter can be specified, not both. If -exclude-sources is specified, the specified sources will NOT be searched. Note that the sources specified should be enabled.

Sample Value: Orion%20Health%E2%84%A2%20R4%20C-CDA%20Results%20Organizations

Name:

_elements

optional

Type:

query

Data Type:

string

Description:

Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.

Sample Value: _elements=type,name,_elements:exclude=*.type

Name:

_format

optional

Type:

query

Data Type:

string

Description:

Media type of the response. It takes precedence over the accept header. Possible values are json and xml.

Default Value: xml

Sample Value: json

Name:

_pretty

optional

Type:

query

Data Type:

string

Description:

Ask for a pretty printed response for human convenience.

Default Value: true

Sample Value: true

Name:

-cursor

optional

Type:

query

Data Type:

string

Description:

This is a server internal parameter to navigate different pages, indicating the server a cursor till where result matches were already returned.

This parameter is returned by the server as part of the next link of a paginated query.

Name:

_count

optional

Type:

query

Data Type:

integer

Description:

Limit the number of match results to the specified _count. When _count is specified, the query will be paginated, and only _count or less results will be returned.

The returned bundle may contain a next link if more results could be available.

Sample Value: 30

Name:

_sort

optional

Type:

query

Data Type:

string

Description:

Request which order results should be returned in.

Supported _sort parameters are:

• name to sort by Organization.name ascending
• -name to sort by Organization.name descending
• _lastUpdated to sort by Organization.meta.lastUpdated ascending
• -_lastUpdated to sort by Organization.meta.lastUpdated descending.

You can use any combination of the parameters.

Default Value: -_lastUpdated

Sample Value: _sort=-name,_sort=-name, -_lastUpdated

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.

Sample Value: X-Request-ID: adUEctf6urd

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml.

Default Value: application/xml

Sample Value: application/json

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

Specifies the language that the results will be translated to. If not specified it will default to the server's locale. (e.g. fr-FR for french)

Sample Value: en-US

Name:

CSRF-Token

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. The csrfToken from the OHP session must be included in this header.

System will validate the token and reject the request if the token is invalid or not present.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.

Name:

X-Send-Open-API

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.

System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.

Name:

Content-Type

required

Type:

header

Data Type:

string

Description:

Specifies how to encode the form data. The Content-Type value must be application/x-www-form-urlencoded.

Sample Value: application/x-www-form-urlencoded

Name:

active

optional

Type:

formData

Data Type:

string

Description:

Filters organizations to include those that are currently active or inactive, identified by Organization.active. The possible values for this search parameter can only be one of:

• true
• false

Sample Value: true

Name:

address

optional

Type:

formData

Data Type:

array

Description:

Filters the organizations to those that their address is matching the requested address, identified by Organization.address.

Note: Supports passing in a comma-separated list of values.

Sample Value: Main St, Grafton Road

Name:

address-city

optional

Type:

formData

Data Type:

array

Description:

Filters the organizations to those that their address city is matching the requested address-city, identified by Organization.address.city.

Note: Supports passing in a comma-separated list of values.

Sample Value: San Diego, Nashville

Name:

address-country

optional

Type:

formData

Data Type:

array

Description:

Filters the organizations to those that their address country is matching the requested address-country, identified by Organization.address.country.

Note: Supports passing in a comma-separated list of values.

Sample Value: United States, Canada, New Zealand

Name:

address-postalcode

optional

Type:

formData

Data Type:

array

Description:

Filters the organizations to those that their address postal code is matching the requested address-postalcode, identified by Organization.address.postalCode.

Note: Supports passing in a comma-separated list of values.

Sample Value: 10004, 10020

Name:

address-state

optional

Type:

formData

Data Type:

array

Description:

Filters the organizations to those that their address state is matching the requested address-state identified by Organization.address.state.

Note: Supports passing in a comma-separated list of values.

Sample Value: California,Ohio,Georgia

Name:

address-use

optional

Type:

formData

Data Type:

array

Description:

Filters the organizations to those that match the specified address-use, identified by Organization.address.use. Possible values are:

• home
• work
• temp
• old

• billing

  Note:

  • if an address use system is specified, only http://hl7.org/fhir/address-use can be used.
  • Supports passing in a comma-separated list of values.

Sample Value: home,work

Name:

endpoint

optional

Type:

formData

Data Type:

array

Description:

Filters the organizations to those that match the specified endpoint references, identified by Organization.endpoint.

Note: the endpoint can be chained to define filters on the reference endpoint, each of the chained parameters can specify multiple comma separated values.

Sample Value: endpoint.name=Questionnaire Destination&endpoint.status=active&endpoint.connection-type=http://terminology.hl7.org/CodeSystem/endpoint-connection-type|ihe-xcpd

Name:

identifier

optional

Type:

formData

Data Type:

array

Description:

Filters the organizations to those that have identifiers that match at least one of the specified identifiers.

Note: The identifier can be a single item or a comma separated list of identifiers. Each identifier is defined by system and value , separated using a URL encoded | character i.e. %7c.

Sample Value: http://hl7.org/fhir/sid/us-npi|1234567890, urn:text:sysA|org345"

Name:

name

optional

Type:

formData

Data Type:

array

Description:

Filters the organizations to those that have a matching Location.name or Location.alias. The search for name allows partial matches, is case insensitive and can match any one of the specified names.

Note: Supports passing in a comma-separated list of values.

Sample Value: Metro City Neurology Department

Name:

partof

optional

Type:

formData

Data Type:

array

Description:

Filters the organizations to those that form a part of the specified referenced organization,identified by Organization.partOf.

Note: partof can be chained to define filter on the reference organization, each of the chained organization can specify multiple comma separated values.

Sample Value: partof.active=true&partof.type=http://terminology.hl7.org/CodeSystem/organization-type|prov&partof.address=123 Main St Suite 200 Anytown CA 12345 USA

Name:

phonetic

optional

Type:

formData

Data Type:

array

Description:

Filters the organizations by giving a portion of the organization's name using some phonetic matching algorithm.

Note: Supports passing in a comma-separated list of values.

Sample Value: UMC Cardiology unit

Name:

type

optional

Type:

formData

Data Type:

array

Description:

Filters the organizations to those that match the specified type. The type value consists of a coding system and a code separated using a URL encoded | character i.e. %7c.

Note: Supports passing in a comma-separated list of values.

Sample Value: http://terminology.hl7.org/CodeSystem/organization-type|prov

Name:

organization-location

optional

Type:

formData

Data Type:

array

Description:

Filters the organizations to those to a Location reference (plannet-Location) defining the coverage area of a health insurance provider network.

Note:

• This is a pdex-plan-net search parameter for health insurance provider network that match the Organization.extension.where(url='http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/location-reference).

• The organization-location can be chained to define filters on the reference Location, each of the chained parameters can specify multiple comma separated values.

Sample Value: organization-location.identifier=SYS_A|L1

Name:

_lastUpdated

optional

Type:

formData

Data Type:

array

Description:

Allows the user to filter organizations by the lastUpdated date. The date value can be a single date, as well as lower and/or upper bound.

The supported operations are: =gt, =ge, =lt, =ne, =le, =eq. For more information about using these search operators, refer to the date section on the FHIR Search page.

The {dateTimeValue} value should be in the following format: 2013-01-01T23:00:00-05:00. However, the time portion can be excluded. If a time portion is provided, the time zone must be provided as well.

It is highly recommended to provide the time zone portion in any query. Ensure that special characters such as '+' are encoded so that it can be interpreted correctly. For example: "2014-01-01T00:00:00+13:00" should be encoded like this: "2014-01-01T00:00:00%2B13:00".

If a date query comes in without a time zone, the date will be interpreted according to the server's time zone.

Including this query parameter includes all Organizations that match the specified Organization.meta.lastUpdated.

Sample Value: _lastUpdated=gt2012-01-01

Name:

_summary

optional

Type:

formData

Data Type:

string

Description:

Instructs the server to return a subset of the resource, reducing the size of the reponse payload. Possible values are

• true: return summaries only
• false: return full resources
• count: return the count of search matches
• text: return only the text, id, meta, and top-level mandatory elements
• data: remove the text element

Sample Value: true

Name:

-include-sources

optional

Type:

formData

Data Type:

array

Description:

The -include-sources parameter defines which sources should be queried for the results.

Note: Either -include-sources or -exclude-sources parameter can be specified, not both. If -include-sources is specified, ONLY the specified sources will be searched. Note that the sources specified should be enabled.

Sample Value: Orion%20Health%E2%84%A2%20R4%20C-CDA%20Results%20Organizations

Name:

-exclude-sources

optional

Type:

formData

Data Type:

array

Description:

The -exclude-sources parameter defines which sources should NOT be queried for the results.

Note: Either -include-sources or -exclude-sources parameter can be specified, not both. If -exclude-sources is specified, the specified sources will NOT be searched. Note that the sources specified should be enabled.

Sample Value: Orion%20Health%E2%84%A2%20R4%20C-CDA%20Results%20Organizations

Name:

_elements

optional

Type:

formData

Data Type:

string

Description:

Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.

Sample Value: _elements=type,name,_elements:exclude=*.type

Name:

_format

optional

Type:

formData

Data Type:

string

Description:

Media type of the response. It takes precedence over the accept header. Possible values are json and xml.

Default Value: xml

Sample Value: json

Name:

_pretty

optional

Type:

formData

Data Type:

string

Description:

Ask for a pretty printed response for human convenience.

Default Value: true

Sample Value: true

Name:

-cursor

optional

Type:

formData

Data Type:

string

Description:

This is a server internal parameter to navigate different pages, indicating the server a cursor till where result matches were already returned.

This parameter is returned by the server as part of the next link of a paginated query.

Name:

_count

optional

Type:

formData

Data Type:

integer

Description:

Limit the number of match results to the specified _count. When _count is specified, the query will be paginated, and only _count or less results will be returned.

The returned bundle may contain a next link if more results could be available.

Sample Value: 30

Name:

_sort

optional

Type:

formData

Data Type:

string

Description:

Request which order results should be returned in.

Supported _sort parameters are:

• name to sort by Organization.name ascending
• -name to sort by Organization.name descending
• _lastUpdated to sort by Organization.meta.lastUpdated ascending
• -_lastUpdated to sort by Organization.meta.lastUpdated descending.

You can use any combination of the parameters.

Default Value: -_lastUpdated

Sample Value: _sort=-name,_sort=-name, -_lastUpdated

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.

Sample Value: X-Request-ID: adUEctf6urd

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml.

Default Value: application/xml

Sample Value: application/json

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

Specifies the language that the results will be translated to. If not specified it will default to the server's locale. (e.g. fr-FR for french)

Sample Value: en-US

Name:

CSRF-Token

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. The csrfToken from the OHP session must be included in this header.

System will validate the token and reject the request if the token is invalid or not present.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.

Name:

X-Send-Open-API

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.

System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.

Name:

id

required

Type:

path

Data Type:

string

Description:

The id of the Organization resource to query for

Sample Value: shaTWIQUXLR7RLNCR45AMPETZEQYJ6UDN6OV43CD6JCRJJZE3OX6IJQ

Name:

_elements

optional

Type:

query

Data Type:

string

Description:

Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.

Sample Value: _elements=type,name,_elements:exclude=*.type

Name:

_pretty

optional

Type:

query

Data Type:

string

Description:

Ask for a pretty printed response for human convenience.

Default Value: true

Sample Value: true

Name:

_format

optional

Type:

query

Data Type:

string

Description:

Media type of the response. It takes precedence over the accept header. Possible values are json and xml.

Default Value: xml

Sample Value: json

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml.

Default Value: application/xml

Sample Value: application/json

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.

Sample Value: X-Request-ID: adUEctf6urd

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

Specifies the language that the results will be translated to. If not specified it will default to the server's locale. (e.g. fr-FR for french)

Sample Value: en-US

Name:

CSRF-Token

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. The csrfToken from the OHP session must be included in this header. System will validate the token and reject the request if the token is invalid or not present.

Name:

X-Send-Open-API

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. This header is required to distinguish the api requests from known senders. System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request.

Name:

id

required

Type:

path

Data Type:

string

Description:

The id of the Organization resource to query for.

Sample Value: shaOUMPBJFJM2WN57EXMBGFFKFRURHG5DIM4D6KWZ5KPS6ZSJUNYDEA

Name:

_elements

optional

Type:

query

Data Type:

string

Description:

Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.

Sample Value: _elements=type,name,_elements:exclude=*.type

Name:

_pretty

optional

Type:

query

Data Type:

string

Description:

Ask for a pretty printed response for human convenience.

Default Value: true

Sample Value: true

Name:

_format

optional

Type:

query

Data Type:

string

Description:

Media type of the response. It takes precedence over the accept header. Possible values are json and xml.

Default Value: xml

Sample Value: json

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml.

Default Value: application/xml

Sample Value: application/json

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.

Sample Value: X-Request-ID: adUEctf6urd

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

Specifies the language that the results will be translated to. If not specified it will default to the server's locale. (e.g. fr-FR for french)

Sample Value: en-US

Name:

CSRF-Token

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. The csrfToken from the OHP session must be included in this header. System will validate the token and reject the request if the token is invalid or not present.

Name:

X-Send-Open-API

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. This header is required to distinguish the api requests from known senders. System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request.

Name:

id

required

Type:

path

Data Type:

string

Description:

The id of the Organization resource

Sample Value: shaOUMPBJFJM2WN57EXMBGFFKFRURHG5DIM4D6KWZ5KPS6ZSJUNYDEA

Name:

versionid

required

Type:

path

Data Type:

integer

Description:

The version of the Organization resource

Sample Value: 1

Name:

_elements

optional

Type:

query

Data Type:

string

Description:

Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.

Sample Value: _elements=type,name,_elements:exclude=*.type

Name:

_pretty

optional

Type:

query

Data Type:

string

Description:

Ask for a pretty printed response for human convenience.

Default Value: true

Sample Value: true

Name:

_format

optional

Type:

query

Data Type:

string

Description:

Media type of the response. It takes precedence over the accept header. Possible values are json and xml.

Default Value: xml

Sample Value: json

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml.

Default Value: application/xml

Sample Value: application/json

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.

Sample Value: X-Request-ID: adUEctf6urd

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

Specifies the language that the results will be translated to. If not specified it will default to the server's locale. (e.g. fr-FR for french)

Sample Value: en-US

Name:

CSRF-Token

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. The csrfToken from the OHP session must be included in this header. System will validate the token and reject the request if the token is invalid or not present.

Name:

X-Send-Open-API

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. This header is required to distinguish the api requests from known senders. System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request.