Patient Relationship
Base Path: /patient/{patientIdentifier}/relationship
Version: 1.0.0
REST service that retrieves the known relationships for a given patient, either by a particular relationship type or a relationship type group.
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
Get relationships for a patient
GET /patient/{patientIdentifier}/relationship/
Retrieve the known relationships for the patient.
Parameters
Name
Type
Data Type
Description
Name:
includeInactive
optional
Type:
query
Data Type:
boolean
Description:
The value will be true if inactive relationships should be included
Sample Value: true
Name:
patientIdentifier
required
Type:
path
Data Type:
string
Description:
The value will be true if inactive relationships should be
Sample Value: AAAA-0124-8@ORION
Responses
200
The request was successful
Sample Request
curl -X GET "https://api.orionhealth.io/patient/AAAA-0124-8@ORION/relationship/?includeInactive=true" \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <Access Token>'Get relationships for a patient for a group
GET /patient/{patientIdentifier}/relationship/group/{group}
Retrieve the known relationships for the patient, limited to relationship types that are part of the provided relationship type group.
Parameters
Name
Type
Data Type
Description
Name:
group
required
Type:
path
Data Type:
string
Description:
Sample Value: Notifications
Name:
includeInactive
optional
Type:
query
Data Type:
boolean
Description:
The value will be true if inactive relationships should be included
Sample Value: true
Name:
patientIdentifier
required
Type:
path
Data Type:
string
Description:
The value will be true if inactive relationships should be
Sample Value: AAAA-0124-8@ORION
Responses
200
The request was successful
Sample Request
curl -X GET "https://api.orionhealth.io/patient/AAAA-0124-8@ORION/relationship/group/Notifications?includeInactive=true" \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <Access Token>'Get relationships for a patient for a type
GET /patient/{patientIdentifier}/relationship/type/{type}
Retrieve the known relationships for the patient, limited to a particular relationship type.
Parameters
Name
Type
Data Type
Description
Name:
type
required
Type:
path
Data Type:
string
Description:
the unique identifier for the relationship type to limit the relationships
Sample Value: PCP
Name:
includeInactive
optional
Type:
query
Data Type:
boolean
Description:
The value will be true if inactive relationships should be included
Sample Value: true
Name:
patientIdentifier
required
Type:
path
Data Type:
string
Description:
The value will be true if inactive relationships should be
Sample Value: AAAA-0124-8@ORION
Responses
200
The request was successful
Sample Request
curl -X GET "https://api.orionhealth.io/patient/AAAA-0124-8@ORION/relationship/type/PCP?includeInactive=true" \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <Access Token>'