FHIR OrganizationAffiliation
Base Path: /fhir/4.0/OrganizationAffiliation
Version: 1.0.0
The FHIR OrganizationAffiliation API allows you to look up and retrieve OrganizationAffiliation information. The endpoint provides the ability to:
- Retrieve all OrganizationAffiliation resources that match a search criteria.
- Retrieve a specific OrganizationAffiliation resource based on its FHIR ID.
- Retrieve the history of an OrganizationAffiliation resource based on its FHIR ID.
The data returned in this API is subject to privacy and permissions settings, refer to the Working with Privacy guide to learn how this might affect your application.
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
Retrieve OrganizationAffiliation Resources by Criteria
GET /fhir/4.0/OrganizationAffiliation/
This method returns all OrganizationAffiliations by search criteria.
Parameters
Name
Type
Data Type
Description
Name:
specialty
optional
Type:
query
Data Type:
array
Description:
Filters the OrganizationAffiliations based on the specialty of the participatingOrganization in the context of the OrganizationAffiliation role.
Sample Value: Dermatology|408443003
Name:
active
optional
Type:
query
Data Type:
string
Description:
Filters the OrganizationAffiliations based on their current status.
Note: Set the value to true to retrieve active OrganizationAffiliations or false to retrieve inactive OrganizationAffiliations.
Sample Value: true
Name:
date
optional
Type:
query
Data Type:
array
Description:
Filters the OrganizationAffiliations by the period during which the participating organization is affiliated with the primary organization.
The supported prefixes are gt, ge, lt, le and eq. If no prefix is used, exact date or date-time matching is implied.
Dates must be formatted according to ISO 8601 either as a date only (e.g. 1997-07-16) or as a date-time including the timezone (e.g. 1997-07-16T19:20:30+13:00).
Ensure that special characters such as + are URL encoded i.e. %2B.
Sample Value: gt2013-01-01T01:00:00%2B13:00
Name:
optional
Type:
query
Data Type:
string
Description:
Filters the OrganizationAffiliations based on the contact email.
Sample Value: info@lakesidehospital.com
Name:
endpoint
optional
Type:
query
Data Type:
array
Description:
Filters the OrganizationAffiliations based on the reference endpoints providing access to services operated for this role. Note: This parameter can be chained to further define filters on the reference endpoint. For each chained parameter, you can specify multiple values separated by commas.
Sample Value: endpoint.name=Health Intersections CarePlan Hub
Name:
identifier
optional
Type:
query
Data Type:
array
Description:
Filters the OrganizationAffiliations that match the specific identifier.
Sample Value: http://www.acme.org/practitioners|23
Name:
location
optional
Type:
query
Data Type:
array
Description:
Filters the OrganizationAffiliations based on the location reference at which the role orccurs.
Note: This parameter can be chained to further define filters on the reference location. For each chained parameter, you can specify multiple values separated by commas.
for example: location.name=medical-center&location.address-city=Auckland
Sample Value: location=Location/16
Name:
network
optional
Type:
query
Data Type:
array
Description:
Filters the OrganizationAffiliations based on health insurance provider network references. Note: This parameter can be chained to further define filters on the reference organization. For each chained parameter, you can specify multiple values separated by commas. For example:
network.name
Sample Value: network=Organization/hl7pay
Name:
participating-organization
optional
Type:
query
Data Type:
array
Description:
Filters the OrganizationAffiliations based on the organization that provides services to the primary organization.
Note: This parameter can be chained to further define filters on the reference organization. For each chained parameter, you can specify multiple values separated by commas.
For example: participating-organization.name=Private Hospital&participating-organization.type=Hospital|0045
Sample Value: participating-organization=Organization/f001
Name:
phone
optional
Type:
query
Data Type:
string
Description:
Filters the OrganizationAffiliations based on the contact phone number.
Sample Value: 34059342
Name:
primary-organization
optional
Type:
query
Data Type:
array
Description:
Filters the OrganizationAffiliations based on the organization that receives the services from the participating organization. Note: This parameter can be chained to further define filters on the reference organization. For each chained parameter, you can specify multiple values separated by commas.
Sample Value: primary-organization=Organization/hl7pay
Name:
role
optional
Type:
query
Data Type:
array
Description:
Filters the OrganizationAffiliations based on the role the participatingOrganization plays.
Sample Value: Provider|provider
Name:
service
optional
Type:
query
Data Type:
array
Description:
Filters the OrganizationAffiliation based on the HealthcareService references.
Note: This parameter can be chained to further define filters on the reference healthcareService. For each chained parameter, you can specify multiple values separated by commas.
For example: service.service-category=Private Hospital&ervice.location=Hospital|0045.
Sample Value: service=HealthcareService/d0014
Name:
telecom
optional
Type:
query
Data Type:
string
Description:
Filters the OrganizationAffiliations based on a value in any kind of contact.
Sample Value: fax|+1-555-987-1234
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%20HL7V2%20OrganizationAffiliations
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%20HL7V2%20OrganizationAffiliations
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 json.
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 a FHIR Bundle containing 0..* OrganizationAffiliation 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
Get all OrganizationAffiliations by crietria
curl -X GET "https://developer-solution/fhir/4.0/OrganizationAffiliation/?specialty=Dermatology%7C408443003" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='Retrieve OrganizationAffiliations by criteria
POST /fhir/4.0/OrganizationAffiliation/_search
This method returns all OrganizationAffiliations by search criteria. This is the secure alternative to the GET search.
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:
specialty
optional
Type:
query
Data Type:
array
Description:
Filters the OrganizationAffiliations based on the specialty of the participatingOrganization in the context of the OrganizationAffiliation role.
Sample Value: Dermatology|408443003
Name:
active
optional
Type:
query
Data Type:
string
Description:
Filters the OrganizationAffiliations based on their current status.
Note: Set the value to true to retrieve active OrganizationAffiliations or false to retrieve inactive OrganizationAffiliations.
Sample Value: true
Name:
date
optional
Type:
query
Data Type:
array
Description:
Filters the organizationAffiliations by the period during which the participatingOrganization is affiliated with the primary organization.
The supported prefixes are gt, ge, lt, le and eq. If no prefix is used, exact date or date-time matching is implied.
Dates must be formatted according to ISO 8601 either as a date only (e.g. 1997-07-16) or as a date-time including the timezone (e.g. 1997-07-16T19:20:30+13:00).
Ensure that special characters such as + are URL encoded i.e. %2B.
Sample Value: gt2013-01-01T01:00:00%2B13:00
Name:
optional
Type:
query
Data Type:
string
Description:
Filters the OrganizationAffiliations based on the contact email.
Sample Value: info@lakesidehospital.com
Name:
endpoint
optional
Type:
query
Data Type:
array
Description:
Filters the OrganizationAffiliations based on the reference endpoints providing access to services operated for this role. Note: This parameter can be chained to further define filters on the reference endpoint. For each chained parameter, you can specify multiple values separated by commas.
Sample Value: endpoint.name=Health Intersections CarePlan Hub
Name:
identifier
optional
Type:
query
Data Type:
array
Description:
Filters the OrganizationAffiliations that match the specific identifier.
Sample Value: http://www.acme.org/practitioners|23
Name:
location
optional
Type:
query
Data Type:
array
Description:
Filters the OrganizationAffiliations based on the location at which the role orccurs.
Note: This parameter can be chained to further define filters on the reference location. For each chained parameter, you can specify multiple values separated by commas.
for example: location.name=medical-center&location.address-city=Auckland
Sample Value: location=Location/16
Name:
network
optional
Type:
query
Data Type:
array
Description:
Filters the OrganizationAffiliations based on health insurance provider network references. Note: This parameter can be chained to further define filters on the reference organization. For each chained parameter, you can specify multiple values separated by commas. Supports chained parameter search, for example:
network.name
Sample Value: network=Organization/hl7pay
Name:
participating-organization
optional
Type:
query
Data Type:
array
Description:
Filters the OrganizationAffiliations based on the organization that provides services to the primary organization.
Note: This can be chained to define filters on the reference organization, each of the chained parameters can specify multiple comma separated values.
For example: participating-organization.name=Private Hospital&participating-organization.type=Hospital
Sample Value: participating-organization=Organization/f001
Name:
phone
optional
Type:
query
Data Type:
string
Description:
Filters the OrganizationAffiliations based on the contact phone number.
Sample Value: 34059342
Name:
primary-organization
optional
Type:
query
Data Type:
array
Description:
Filters the OrganizationAffiliations based on the organization that receives the services from the participating organization. Note: This can be chained to define filters on the reference organization.
Sample Value: primary-organization=Organization/hl7pay
Name:
role
optional
Type:
query
Data Type:
array
Description:
Filters the OrganizationAffiliations based on the role the participatingOrganization plays.
Sample Value: Provider|provider
Name:
service
optional
Type:
query
Data Type:
array
Description:
Filters the OrganizationAffiliation based on the HealthcareService references.
Note: This parameter can be chained to further define filters on the reference organization. For each chained parameter, you can specify multiple values separated by commas.
For example: service.service-category=Private Hospital&ervice.location=Hospital|0045.
Sample Value: service=HealthcareService/d0014
Name:
telecom
optional
Type:
query
Data Type:
string
Description:
Filters the OrganizationAffiliations based on a value in any kind of contact.
Sample Value: fax|+1-555-987-1234
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%20HL7V2%20OrganizationAffiliations
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%20HL7V2%20OrganizationAffiliations
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 json.
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 a FHIR Bundle containing 0..* OrganizationAffiliation 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
Get all OrganizationAffiliations by specific crietria
curl -X POST "https://developer-solution/fhir/4.0/OrganizationAffiliation/_search?specialty=Dermatology%7C408443003" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='Retrieve a single OrganizationAffiliation
GET /fhir/4.0/OrganizationAffiliation/{id}
This method returns the OrganizationAffiliation 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 OrganizationAffiliation resource to retrieve.
Sample Value: GRQTEZRVGI4GILJTMQ4WMLJUGIYTILLBGJRTALLFMM2TGZRRG44TOZLDGJAFGMI
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 json.
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 OrganizationAffiliation resource matching the requested resource ID.
400
This code is returned when the FHIR ID is empty or not valid.
404
No OrganizationAffiliation resource found with the requested resource ID.
Sample Requests
Retrieve an OrganizationAffiliation identified by a specific resource id
curl -X GET "https://developer-solution/fhir/4.0/OrganizationAffiliation/GRQTEZRVGI4GILJTMQ4WMLJUGIYTILLBGJRTALLFMM2TGZRRG44TOZLDGJAFGMI" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='Retrieve History for an OrganizationAffiliation Resource by its FHIR ID
GET /fhir/4.0/OrganizationAffiliation/{id}/_history
This method returns all the versions for a specific OrganizationAffiliation resource based on its FHIR ID.
Parameters
Name
Type
Data Type
Description
Name:
id
required
Type:
path
Data Type:
string
Description:
The id of the OrganizationAffiliation resource to retrieve history for.
Sample Value: GRQTEZRVGI4GILJTMQ4WMLJUGIYTILLBGJRTALLFMM2TGZRRG44TOZLDGJAFGMI
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 json.
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 history of an OrganizationAffiliation with given id in the response body.
404
OrganizationAffiliation resource id is specified, but no corresponding resource is found.
Sample Requests
Retrieve the history of an OrganizationAffiliation identified a specific resource id
curl -X GET "https://developer-solution/fhir/4.0/OrganizationAffiliation/GRQTEZRVGI4GILJTMQ4WMLJUGIYTILLBGJRTALLFMM2TGZRRG44TOZLDGJAFGMI/_history" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='