FHIR OrganizationAffiliation

Base Path: /fhir/4.0/OrganizationAffiliation

Version: 2.0.0

The FHIR OrganizationAffiliation API allows you to look up details about the FHIR 4.0 OrganizationAffiliation. OrganizationAffiliation is the non-hierarchical relationships between organizations. The relationship can optionally include details of locations/services from the participating organization.

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.
  • Retrieve a specific version of an OrganizationAffiliation resource based on its FHIR ID and Version ID.
  • Retrieve OrganizationAffiliation results from third-party sources.

The OrganizationAffiliation API aggregates data from multiple sources, to learn about working with aggregated APIs refer to the Working with Aggregation 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

Retrieve OrganizationAffiliations

GET /fhir/4.0/OrganizationAffiliation/

Return all OrganizationAffiliation resources for the given search criteria, or all OrganizationAffiliations if a search criteria is not specified.

Parameters

Name

Type

Data Type

Description

Name:

active

optional

Type:

query

Data Type:

boolean

Description:

Filters the organizationAffiliations to those that are active, identified by OrganizationAffiliation.active.

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


Sample Value: true

Name:

date

optional

Type:

query

Data Type:

array

Description:

Filters the organizationAffiliations to those with period on, before, or after a specific date, date-time, or date range. 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.

The format of the query is

  • date=gt{dateTimeValue}
  • date=ge{dateTimeValue}&date=le{dateTimeValue}


Sample Value: date=gt2012-01-01

Name:

email

optional

Type:

query

Data Type:

array

Description:

Filters the organizationAffiliations which has the participatingOrganization with contact that match the specified email, identified by OrganizationAffiliation.telecom.where(system='email').

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


Sample Value: email=general.practice@example.org, general.practice2@example.org

Name:

endpoint

optional

Type:

query

Data Type:

array

Description:

Filters the organizationAffiliations to those that match the specified technical Endpoint reference, identified by OrganizationAffiliation.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.connection-type=http://terminology.hl7.org/CodeSystem/endpoint-connection-type|ihe-iid&endpoint.status=active

Name:

identifier

optional

Type:

query

Data Type:

array

Description:

Filters the organizationAffiliations to those that match the specified identifier, identified by OrganizationAffiliation.identifier.

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,ORION|12345

Name:

location

optional

Type:

query

Data Type:

array

Description:

Filters the organizationAffiliations to those that match the specified location reference, identified by OrganizationAffiliation.location.

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


Sample Value: location.type=Diagnostics%20or%20therapeutics%20unit%7CDX

Name:

network

optional

Type:

query

Data Type:

array

Description:

Filters the organizationAffiliations to those that match the specified network reference, identified by OrganizationAffiliation.network.

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


Sample Value: network.name=HL7 Payer Network

Name:

participating-organization

optional

Type:

query

Data Type:

array

Description:

Filters the organizationAffiliations to those that have an organization that provides services to the primary organization, matching the specified organization references, identified by OrganizationAffiliation.participatingOrganization.

Note: the participating-organization can be chained to define filters on the reference 'Organization', each of the chained parameters can specify multiple comma separated values.


Sample Value: participating-organization=SYS_A|O1

Name:

phone

optional

Type:

query

Data Type:

array

Description:

Filters the organizationAffiliations to those that match the specified phone contact value.

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


Sample Value: phone|010-2374-284,phone|010-2374-284

Name:

primary-organization

optional

Type:

query

Data Type:

array

Description:

Filters the organizationAffiliations to those that have an organization that receive services from the primary organization, matching the specified organization references, identified by OrganizationAffiliation.organization.

Note: the primary-organization can be chained to define filters on the reference 'Organization', each of the chained parameters can specify multiple comma separated values.


Sample Value: primary-organization.name=HL7 Payer Organization

Name:

role

optional

Type:

query

Data Type:

array

Description:

Filters the organizationAffiliations to those that has the participating organization match the specified role, identified by OrganizationAffiliation.code.

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


Sample Value: http://terminology.hl7.org/CodeSystem/organization-role|provider, http://terminology.hl7.org/CodeSystem/organization-role|agency

Name:

service

optional

Type:

query

Data Type:

array

Description:

Filters the organizationAffiliations that provides services to the specified healthcare service references, identified by OrganizationAffiliation.service.

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


Sample Value: service.type=http://terminology.hl7.org/CodeSystem/service-type|14, http://terminology.hl7.org/CodeSystem/service-type|9

Name:

specialty

optional

Type:

query

Data Type:

array

Description:

Filters the organizationAffiliations to those that has the participating organization match the specified specialty, identified by OrganizationAffiliation.specialty.

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


Sample Value: Dermatology%7C408443003,http://snomed.info/sct|421661004

Name:

telecom

optional

Type:

query

Data Type:

array

Description:

Filters the organizationAffiliations to those that has specified contact value.

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


Sample Value: telecom=email|general.practice@example.org, phone|21467335

Name:

_lastUpdated

optional

Type:

query

Data Type:

array

Description:

Filters based on when the resource version was last changed, before, or after a specific date, date-time, or date range. 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.

The format of the query is

  • _lastUpdated=gt{dateTimeValue}
  • _lastUpdated=ge{dateTimeValue}&_lastUpdated=le{dateTimeValue}


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: -include-sources=Orion%20Health%E2%84%A2%20R4%20C-CDA%20Results%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: -exclude-sources=Orion%20Health%E2%84%A2%20R4%20C-CDA%20Results%20OrganizationAffiliations

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=code,specialty,_elements:exclude=*.organization

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:

_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:

  • active to sort by OrganizationAffiliation.active ascending
  • -active to sort by OrganizationAffiliation.active descending
  • date to sort by OrganizationAffiliation.period.start ascending
  • -date to sort by OrganizationAffiliation.period.start descending
  • _lastUpdated to sort by OrganizationAffiliation.Meta.lastUpdated ascending
  • -_lastUpdated to sort by OrganizationAffiliation.Meta.lastUpdated descending

You can use any combination of the parameters.


Default Value: -active,-date

Sample Value: _sort=-_lastUpdated, active

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


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.


Responses

application/json+fhir

200

Returns a FHIR Bundle containing 0..* OperationOutcome resources and 0..* OrganizationAffiliation resources

application/json+fhir

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 OrganizationAffiliations by specialty and active
curl -X GET "https://developer-solution/fhir/4.0/OrganizationAffiliation?active=true&specialty=Dermatology%7C408443003,http://snomed.info/sct%7C421661004" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='

Retrieve OrganizationAffiliations

POST /fhir/4.0/OrganizationAffiliation/_search

Return all OrganizationAffiliation resources for the given search criteria, or all OrganizationAffiliations 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:

active

optional

Type:

formData

Data Type:

boolean

Description:

Filters the organizationAffiliations to those that are active, identified by OrganizationAffiliation.active.

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


Sample Value: true

Name:

date

optional

Type:

formData

Data Type:

array

Description:

Filters the organizationAffiliations to those with period on, before, or after a specific date, date-time, or date range. 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.

The format of the query is

  • date=gt{dateTimeValue}
  • date=ge{dateTimeValue}&date=le{dateTimeValue}


Sample Value: date=gt2012-01-01

Name:

email

optional

Type:

formData

Data Type:

array

Description:

Filters the organizationAffiliations which has the participatingOrganization with contact that match the specified email, identified by OrganizationAffiliation.telecom.where(system='email').

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


Sample Value: email=general.practice@example.org, general.practice2@example.org

Name:

endpoint

optional

Type:

formData

Data Type:

array

Description:

Filters the organizationAffiliations to those that match the specified technical Endpoint reference, identified by OrganizationAffiliation.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.connection-type=http://terminology.hl7.org/CodeSystem/endpoint-connection-type|ihe-iid&endpoint.status=active

Name:

identifier

optional

Type:

formData

Data Type:

array

Description:

Filters the organizationAffiliations to those that match the specified identifier, identified by OrganizationAffiliation.identifier.

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,ORION|12345

Name:

location

optional

Type:

formData

Data Type:

array

Description:

Filters the organizationAffiliations to those that match the specified location reference, identified by OrganizationAffiliation.location.

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


Sample Value: location.address=Fantastic%20Blvd

Name:

network

optional

Type:

formData

Data Type:

array

Description:

Filters the organizationAffiliations to those that match the specified network reference, identified by OrganizationAffiliation.network.

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


Sample Value: network.name=HL7 Payer Network

Name:

participating-organization

optional

Type:

formData

Data Type:

array

Description:

Filters the organizationAffiliations to those that have an organization that provides services to the primary organization, matching the specified organization references, identified by OrganizationAffiliation.participatingOrganization.

Note: the participating-organization can be chained to define filters on the reference 'Organization', each of the chained parameters can specify multiple comma separated values.


Sample Value: participating-organization=SYS_A|O1

Name:

phone

optional

Type:

formData

Data Type:

array

Description:

Filters the organizationAffiliations to those that match the specified phone contact value.

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


Sample Value: phone|010-2374-284,phone|010-2374-284

Name:

primary-organization

optional

Type:

formData

Data Type:

array

Description:

Filters the organizationAffiliations to those that have an organization that receive services from the primary organization, matching the specified organization references, identified by OrganizationAffiliation.organization.

Note: the primary-organization can be chained to define filters on the reference 'Organization', each of the chained parameters can specify multiple comma separated values.


Sample Value: primary-organization.name=HL7 Payer Organization

Name:

role

optional

Type:

formData

Data Type:

array

Description:

Filters the organizationAffiliations to those that has the participating organization match the specified role, identified by OrganizationAffiliation.code.

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


Sample Value: http://terminology.hl7.org/CodeSystem/organization-role|provider, http://terminology.hl7.org/CodeSystem/organization-role|agency

Name:

service

optional

Type:

formData

Data Type:

array

Description:

Filters the organizationAffiliations that provides services to the specified healthcare service references, identified by OrganizationAffiliation.service.

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


Sample Value: service.type=http://terminology.hl7.org/CodeSystem/service-type|14, http://terminology.hl7.org/CodeSystem/service-type|9

Name:

specialty

optional

Type:

formData

Data Type:

array

Description:

Filters the organizationAffiliations to those that has the participating organization match the specified specialty, identified by OrganizationAffiliation.specialty.

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


Sample Value: http%3A%2F%2Ffhir.com%2FNamingSystem%7C472

Name:

telecom

optional

Type:

formData

Data Type:

array

Description:

Filters the organizationAffiliations to those that has specified contact value.

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


Sample Value: telecom=email|general.practice@example.org, phone|21467335

Name:

_lastUpdated

optional

Type:

formData

Data Type:

array

Description:

Filters based on when the resource version was last changed, before, or after a specific date, date-time, or date range. 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.

The format of the query is

  • _lastUpdated=gt{dateTimeValue}
  • _lastUpdated=ge{dateTimeValue}&_lastUpdated=le{dateTimeValue}


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: -include-sources=Orion%20Health%E2%84%A2%20R4%20C-CDA%20Results%20OrganizationAffiliations

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: -exclude-sources=Orion%20Health%E2%84%A2%20R4%20C-CDA%20Results%20OrganizationAffiliations

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=code,specialty,_elements:exclude=*.organization

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:

_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:

  • active to sort by OrganizationAffiliation.active ascending
  • -active to sort by OrganizationAffiliation.active descending
  • date to sort by OrganizationAffiliation.period.start ascending
  • -date to sort by OrganizationAffiliation.period.start descending
  • _lastUpdated to sort by OrganizationAffiliation.Meta.lastUpdated ascending
  • -_lastUpdated to sort by OrganizationAffiliation.Meta.lastUpdated descending

You can use any combination of the parameters.


Default Value: -active,-date

Sample Value: _sort=-_lastUpdated, active

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


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.


Responses

application/json+fhir

200

Returns a FHIR Bundle containing 0..* OperationOutcome resources and 0..* OrganizationAffiliation resources

application/json+fhir

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 OrganizationAffiliations by its specialty and active
curl -X POST "https://developer-solution/fhir/4.0/OrganizationAffiliation/_search" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8=' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'active=true' \
-d 'specialty=http%3A%2F%2Ffhir.com%2FNamingSystem%7C472'

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 query for


Sample Value: MUZTCYRXGJSDMLJZHEZTGLJUMU2GCLJZMNSTELJXGNRTOOLCMM2GIOLCMVAFGMI

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=code,specialty,_elements:exclude=*.organization

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.


Responses

application/json+fhir

200

Returns an OrganizationAffiliation resource matching the requested resource ID.

application/json+fhir

400

This code is returned when the FHIR ID is empty or not valid.

application/json+fhir

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/MUZTCYRXGJSDMLJZHEZTGLJUMU2GCLJZMNSTELJXGNRTOOLCMM2GIOLCMVAFGMI" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='

Retrieve an OrganizationAffiliation's history

GET /fhir/4.0/OrganizationAffiliation/{id}/_history

This method returns the change history for an OrganizationAffiliation resource matching the requested resource ID. OrganizationAffiliation resources can be retrieved from multiple data sources, and not all sources are able to return history information. This operation will return an empty set of data if no versions of the specified OrganizationAffiliation can be found, which includes cases where:

  • The specified OrganizationAffiliation resource cannot be found.
  • The data source for the OrganizationAffiliation is unable to return history information.

Parameters

Name

Type

Data Type

Description

Name:

id

required

Type:

path

Data Type:

string

Description:

The id of the OrganizationAffiliation resource to query for


Sample Value: GRQTEZRVGI4GILJTMQ4WMLJUGIYTILLBGJRTALLFMM2TGZRRG44TOZLDGJAFGMI

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=code,specialty,_elements:exclude=*.organization

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.


Responses

application/json+fhir

200

A FHIR Bundle containing 0..* OrganizationAffiliation resources matching the requested resource ID.

application/json+fhir

400

The source providing the OrganizationAffiliation resource is not capable of returning history of OrganizationAffiliation resources.

application/json+fhir

404

No OrganizationAffiliation resource found with the requested resource ID.

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='

Retrieve a specific version of an OrganizationAffiliation

GET /fhir/4.0/OrganizationAffiliation/{id}/_history/{versionid}

This method returns a specific version of the OrganizationAffiliation resource matching the requested resource ID. OrganizationAffiliation resources can be retrieved from multiple data sources. This operation will return an empty set of data if no versions of the specified OrganizationAffiliation can be found, which includes cases where:

  • The specified OrganizationAffiliation resource cannot be found.

Parameters

Name

Type

Data Type

Description

Name:

id

required

Type:

path

Data Type:

string

Description:

The id of the OrganizationAffiliation resource


Sample Value: G5QTSMTFGU3TKLJYGAZTILJUHBSGGLLBGM4TQLJTGJRDIZRTMNSTCZBVMFAFGMI

Name:

versionid

required

Type:

path

Data Type:

integer

Description:

The version of the OrganizationAffiliation 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=code,specialty,_elements:exclude=*.organization

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.


Responses

application/json+fhir

200

Returns an OrganizationAffiliation resource matching the the requested resource ID and version id.

application/json+fhir

400

The source providing the OrganizationAffiliation resource is not capable of returning history of OrganizationAffiliation resources.

application/json+fhir

404

  • No OrganizationAffiliation resource found with the requested resource ID.
  • The version id specified does not exist for the OrganizationAffiliation resource with the requested resource ID.

Sample Requests

Retrieve the version of OrganizationAffiliation identified by a resource id and a version id
curl -X GET "https://developer-solution/fhir/4.0/OrganizationAffiliation/G5QTSMTFGU3TKLJYGAZTILJUHBSGGLLBGM4TQLJTGJRDIZRTMNSTCZBVMFAFGMI/_history/1" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='