FHIR Endpoint
Base Path: /fhir/4.0/Endpoint
Version: 1.0.0
The FHIR Endpoint API allows you to look up details about the FHIR 4.0 Endpoints. The endpoint provides the ability to:
- Retrieve all Endpoint resources that match a search criteria
- Retrieve a specific Endpoint resource based on its FHIR ID.
- Retrieve the history of an Endpoint resource based on its FHIR ID
The Endpoint 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 Endpoint resources using the GET method
GET /fhir/4.0/Endpoint/
Return all Endpoint resources for the given search criteria, or all Endpoints if a search criteria is not specified.
Parameters
Name
Type
Data Type
Description
Name:
connection-type
optional
Type:
query
Data Type:
array
Description:
Filters the endpoints to those that match the specified connection-type
Sample Value: ihe-xdr
Name:
identifier
optional
Type:
query
Data Type:
array
Description:
Filters the endpoints to those that have at least one identifier that matches one of the specified identifiers
Sample Value: http://example.org/enpoint-identifier|epcp12
Name:
name
optional
Type:
query
Data Type:
array
Description:
Filters the endpoints 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: Health Intersections CarePlan Hub
Name:
organization
optional
Type:
query
Data Type:
array
Description:
Filters the endpoints to those with Endpoint.managingOrganization that match the specified managing organization references.
Note: organization can be chained to define filter on the managing reference organizations, each of the chained organization can specify multiple comma separated values.
Sample Value: organization.address.city=Auckland&organization.address=123 Grafton Road&organization.name=University Medical Center, Good Health Clinic
Name:
payload-type
optional
Type:
query
Data Type:
array
Description:
Filters the endpoints to those that match the specified payload-type
Sample Value: http://terminology.hl7.org/CodeSystem/endpoint-payload-type|urn:ihe:pcc:nn:2007
Name:
status
optional
Type:
query
Data Type:
string
Description:
Filters the endpoints that match the specified status.
Sample Value: active
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..* Endpoint 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 Endpoints by a name and a status
curl -X GET "https://developer-solution/fhir/4.0/Endpoint/?name=Health Intersections CarePlan Hub&status=active" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='Returns all available Endpoint resources using the POST method
POST /fhir/4.0/Endpoint/_search
Return all Endpoint resources for the given search criteria, or all Endpoints 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:
connection-type
optional
Type:
formData
Data Type:
array
Description:
Filters the endpoints to those that match the specified connection-type
Sample Value: ihe-xdr
Name:
identifier
optional
Type:
formData
Data Type:
array
Description:
Filters the endpoints to those that have at least one identifier that matches one of the specified identifiers
Sample Value: http://example.org/enpoint-identifier|epcp12
Name:
name
optional
Type:
formData
Data Type:
array
Description:
Filters the endpoints 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: Health Intersections CarePlan Hub
Name:
organization
optional
Type:
formData
Data Type:
array
Description:
Filters the endpoints to those with Endpoint.managingOrganization that match the specified managing organization references.
Note: organization can be chained to define filter on the managing reference organizations, each of the chained organization can specify multiple comma separated values.
Sample Value: organization.address.city=Auckland&organization.address=123 Grafton Road&organization.name=University Medical Center, Good Health Clinic
Name:
payload-type
optional
Type:
formData
Data Type:
array
Description:
Filters the endpoints to those that match the specified payload-type
Sample Value: http://terminology.hl7.org/CodeSystem/endpoint-payload-type|urn:ihe:pcc:nn:2007
Name:
status
optional
Type:
formData
Data Type:
string
Description:
Filters the endpoints that match the specified status.
Sample Value: active
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..* Endpoint resources
400
This response code is returned when the query is invalid e.g. an invalid parameter or a partial token
Sample Requests
Retrieve all Endpoints by its payload-type and identifier
curl -X POST "https://developer-solution/fhir/4.0/Endpoint/_search" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8=' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'identifier=http://example.org/enpoint-identifier%7Cepcp12' \
-d 'payload-type=http://terminology.hl7.org/CodeSystem/endpoint-payload-type%7Curn:ihe:pcc:nn:2007'Retrieve a single Endpoint
GET /fhir/4.0/Endpoint/{id}
This method returns the Endpoint 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 Endpoint 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 Endpoint resource matching the requested resource ID.
404
No Endpoint resource found with the requested resource ID.
Sample Requests
Retrieve an Encounter identified by a specific resource id
curl -X GET "https://developer-solution/fhir/4.0/Endpoint/shaTWIQUXLR7RLNCR45AMPETZEQYJ6UDN6OV43CD6JCRJJZE3OX6IJQ" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='Retrieve an Endpoint's history
GET /fhir/4.0/Endpoint/{id}/_history
This method returns the change history for an Endpoint 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 Endpoint 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..* Endpoint resources matching the requested resource ID.
400
The source providing the Endpoint resource is not capable of returning history of Endpoint resources.
404
No Endpoint resource found with the requested resource ID.
Sample Requests
Retrieve the history of an endpoint identified a specific resource id.
curl -X GET "https://developer-solution/fhir/4.0/Endpoint/shaTZJPZBQMDLCHZG2ZFGLUSU2CUWV2JVI5ZUVHDTNJP6XQCVSJMKFA/_history" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='