FHIR Organization
Base Path: /fhir/4.0/Organization
Version: 1.0.0
The FHIR Organization API allows you to look up details about the FHIR 4.0 Organizations. The endpoint provides the ability to:
- Retrieve all Organization resources that match a search criteria
- Retrieve a specific Organization resource based on its FHIR ID.
- Retrieve the history of an Organization resource based on its FHIR ID
The Organization API aggregates data from multiple sources, to learn about working with aggregated APIs refer to the Aggregated APIs guide in the Knowledge Hub.
This API is based on the R4 release of the FHIR standard, for more information on this API refer to the official FHIR documentation.
Methods
Returns all available Organization resources using the GET method
GET /fhir/4.0/Organization/
Return all Organization resources for the given search criteria, or all Organizations if a search criteria is not specified.
Parameters
Name
Type
Data Type
Description
Name:
name
optional
Type:
query
Data Type:
array
Description:
Filters the organizations to those that have a matching name or alias. The search for name allows partial matches, is case insensitive and can match any one of the specified names.
Sample Value: Burgers UMC Ear Nose Throat unit
Name:
type
optional
Type:
query
Data Type:
array
Description:
Filters the organizations to those that match the specified type.
Sample Value: http://terminology.hl7.org/CodeSystem/organization-type|dept
Name:
partof
optional
Type:
query
Data Type:
array
Description:
Filters the organizations to those that form a part of the specified referenced Organization.
Note: partof can be chained to define filter on the reference organization, each of the chained location 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:
active
optional
Type:
query
Data Type:
string
Description:
Filters the organizations to include those that are currently active or inactive. Possible values for this search parameter are 'true' or 'false' and is case insensitive.
Sample Value: true
Name:
address
optional
Type:
query
Data Type:
string
Description:
Filters the organizations to those that their address is matching the requested address
Sample Value: 123 Main St Suite 200 Anytown CA 12345 USA
Name:
address-city
optional
Type:
query
Data Type:
string
Description:
Filters the organizations to those that their address city is matching the requested address-city
Sample Value: Sydney
Name:
address-country
optional
Type:
query
Data Type:
string
Description:
Filters the organizations to those that their address country is matching the requested address-country
Sample Value: Australia
Name:
address-postalcode
optional
Type:
query
Data Type:
string
Description:
Filters the organizations to those that their address postal code is matching the requested address-postalcode
Sample Value: 1466
Name:
address-state
optional
Type:
query
Data Type:
string
Description:
Filters the organizations to those that their address state is matching the requested address-state
Sample Value: NSW
Name:
address-use
optional
Type:
query
Data Type:
string
Description:
Filters the organizations to those that their address use is matching the requested address-use.
Sample Value: home
Name:
endpoint
optional
Type:
query
Data Type:
array
Description:
Filters the organizations to those which their Organization.endpoint matches the specified endpoint references.
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
Sample Value: http://hl7.org/fhir/sid/us-npi|1234567890
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
Sample Value: UMC Cardiology unit
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.
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.
Name:
_format
optional
Type:
query
Data Type:
string
Description:
Media type of the response. It takes precedence over the accept header.
Default Value: json
Sample Value: json
Name:
Accept
optional
Type:
header
Data Type:
string
Description:
Media type of the response
Default Value: application/xml
Sample Value: application/json
Responses
200
Returns a FHIR Bundle containing 0..* OperationOutcome resources and 0..* Organization resources
400
This response code is returned when the query is invalid e.g. an invalid parameter or a partial token in the search.
Sample Requests
Retrieve all Organizations by a name and an address
curl -X GET "https://developer-solution/fhir/4.0/Organization/?name=Burgers UMC Ear Nose Throat unit&address=123 Main St Suite 200 Anytown CA 12345 USA" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='Returns all available Organization resources using the POST method
POST /fhir/4.0/Organization/_search
Return all Organization resources for the given search criteria, or all Organizations if a search criteria is not specified.
Parameters
Name
Type
Data Type
Description
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:
name
optional
Type:
formData
Data Type:
array
Description:
Filters the organizations to those that have a matching name or alias. The search for name allows partial matches, is case insensitive and can match any one of the specified names.
Sample Value: Burgers UMC Ear Nose Throat unit
Name:
type
optional
Type:
formData
Data Type:
array
Description:
Filters the organizations to those that match the specified type.
Sample Value: http://terminology.hl7.org/CodeSystem/organization-type|dept
Name:
partof
optional
Type:
formData
Data Type:
array
Description:
Filters the organizations to those that form a part of the specified referenced Organization.
Note: partof can be chained to define filter on the reference organization, each of the chained location 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:
active
optional
Type:
formData
Data Type:
string
Description:
Filters the organizations to include those that are currently active or inactive. Possible values for this search parameter are 'true' or 'false' and is case insensitive.
Name:
address
optional
Type:
formData
Data Type:
string
Description:
Filters the organizations to those that their address is matching the requested address
Sample Value: 123 Main St Suite 200 Anytown CA 12345 USA
Name:
address-city
optional
Type:
formData
Data Type:
string
Description:
Filters the organizations to those that their address city is matching the requested address-city
Sample Value: Sydney
Name:
address-country
optional
Type:
formData
Data Type:
string
Description:
Filters the organizations to those that their address country is matching the requested address-country
Sample Value: Australia
Name:
address-postalcode
optional
Type:
formData
Data Type:
string
Description:
Filters the organizations to those that their address postal code is matching the requested address-postalcode
Sample Value: 1466
Name:
address-state
optional
Type:
formData
Data Type:
string
Description:
Filters the organizations to those that their address state is matching the requested address-state
Sample Value: NSW
Name:
address-use
optional
Type:
formData
Data Type:
string
Description:
Filters the organizations to those that their address use is matching the requested address-use.
Sample Value: home
Name:
endpoint
optional
Type:
formData
Data Type:
array
Description:
Filters the organizations to those which their Organization.endpoint matches the specified endpoint references.
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
Sample Value: http://hl7.org/fhir/sid/us-npi|1234567890
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
Sample Value: UMC Cardiology unit
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.
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.
Name:
_format
optional
Type:
formData
Data Type:
string
Description:
Media type of the response. It takes precedence over the accept header.
Default Value: json
Sample Value: json
Name:
Accept
optional
Type:
header
Data Type:
string
Description:
Media type of the response
Default Value: application/xml
Sample Value: application/json
Responses
200
Returns a FHIR Bundle containing 0..* OperationOutcome resources and 0..* Organization resources
400
This response code is returned when the query is invalid e.g. an invalid parameter or a partial token in the search.
Sample Requests
Retrieve all Organizations by an identifer and its address-postalcode
curl -X POST "https://developer-solution/fhir/4.0/Organization/_search" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8=' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'address-postalcode=1466'Retrieve a single Organization
GET /fhir/4.0/Organization/{id}
This method returns the Organization resource matching the requested resource ID.
Parameters
Name
Type
Data Type
Description
Name:
id
required
Type:
path
Data Type:
string
Description:
The id of the Organization resource to query for
Sample Value: shaTWIQUXLR7RLNCR45AMPETZEQYJ6UDN6OV43CD6JCRJJZE3OX6IJQ
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. The default value is 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. The default value is application/xml.
Sample Value: application/xml
Responses
200
Returns an Organization resource matching the requested resource ID.
404
No Organization resource found with the requested resource ID.
Sample Requests
Retrieve an organization identified by a specific resource id
curl -X GET "https://developer-solution/fhir/4.0/Organization/shaTWIQUXLR7RLNCR45AMPETZEQYJ6UDN6OV43CD6JCRJJZE3OX6IJQ" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='Retrieve an Organization's history
GET /fhir/4.0/Organization/{id}/_history
This method returns the change history for an Organization resource matching the requested resource ID.
Parameters
Name
Type
Data Type
Description
Name:
id
required
Type:
path
Data Type:
string
Description:
The id of the Organization resource to query for
Sample Value: shaTZJPZBQMDLCHZG2ZFGLUSU2CUWV2JVI5ZUVHDTNJP6XQCVSJMKFA
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. The default value is 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. The default value is application/xml.
Sample Value: application/xml
Responses
200
A FHIR Bundle containing 0..* Organization resources matching the requested resource ID.
400
The source providing the Organization resource is not capable of returning history of Organization resources.
404
No Organization resource found with the requested resource ID.
Sample Requests
Retrieve the history of an organization identified a specific resource id
curl -X GET "https://developer-solution/fhir/4.0/Organization/shaTZJPZBQMDLCHZG2ZFGLUSU2CUWV2JVI5ZUVHDTNJP6XQCVSJMKFA/_history" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='