FHIR RelatedPerson
Base Path: /fhir/1.0/RelatedPerson
Version: 1.0.0
Allows a user to read and search RelatedPersons.
Authorization: OAuth 2.0 Bearer token is required to access the resources of this API. Once signed up, credentials and URL to access the OAuth API can be found on My Apps Page.
Methods
Search Related Person by ID(s)
GET /fhir/1.0/RelatedPerson/
Return one or more related persons with related person ID(s).
Parameters
Name
Type
Data Type
Description
Name:
_id
required
Type:
query
Data Type:
string
Description:
The comma-separated IDs of one or more related persons.
Sample Value: 1
Name:
_format
optional
Type:
query
Data Type:
string
Description:
Media type of the response, takes precedence over the Accept header.
Default Value: xml
Sample Value: json
Name:
Accept
optional
Type:
header
Data Type:
string
Description:
Media type of the response, either 'application/xml' or 'application/json'. Defaults to 'application/xml'.
Sample Value: application/json+fhir or application/xml+fhir
Responses
200
The related person(s) have been retrieved successfully. An empty list is returned if no related persons are found.
400
There are invalid fields in the request (such as not including all mandatory fields).
Sample Request
curl -X GET "https://api.orionhealth.io/fhir/1.0/RelatedPerson/?_id=1&_format=xml" \
-H 'Accept: application/json+fhir or application/xml+fhir' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <Access Token>'Get Related Person by ID
GET /fhir/1.0/RelatedPerson/{id}
Return a related person with the related person ID.
Parameters
Name
Type
Data Type
Description
Name:
id
required
Type:
path
Data Type:
string
Description:
The ID of the related person.
Sample Value: 1
Name:
_format
optional
Type:
query
Data Type:
string
Description:
Media type of the response, takes precedence over the Accept header.
Default Value: xml
Sample Value: json or xml
Name:
Accept
optional
Type:
header
Data Type:
string
Description:
Media type of the response, either 'application/xml' or 'application/json'. Defaults to 'application/xml'.
Sample Value: application/json+fhir or application/xml+fhir
Responses
200
RelatedPerson resource is found with the given ID.
400
There are invalid fields in the request (such as not including all mandatory fields).
404
No related person is available for the specified parameters.
Sample Request
curl -X GET "https://api.orionhealth.io/fhir/1.0/RelatedPerson/1?_format=xml" \
-H 'Accept: application/json+fhir or application/xml+fhir' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <Access Token>'