Base Path: /fhir/1.0/Flag
Version: 1.0.0
The FHIR Flag API allows you to look up a patient's flags and alerts. The endpoint provides the ability to:
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.
GET /fhir/1.0/Flag/
This method returns all flags for the patient identified by patient.identifier.
Name
Type
Data Type
Description
Name:
patient.identifier
required
Type:
query
Data Type:
string
Description:
The patient identifier consists of patient identifier namespace, also known as the system, and identifier, separated using a URL encoded | character i.e. %7c
.
Sample Value: ORION|AAAA-0124-8
Name:
Accept-Language
optional
Type:
header
Data Type:
string
Description:
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
200
Returns a FHIR Bundle containing 0.. OperationOutcome resources and 0.. Flag resources.
curl -X GET "https://api.orionhealth.io/fhir/1.0/Flag/?patient.identifier=ORION%7CAAAA-0124-8" \
-H 'Accept-Language: en-US' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <Access Token>'
POST /fhir/1.0/Flag/_search
This method returns all Flag resources for a patient. The Flag search using the POST method is a more secure alternative to the Flag search using the GET method.
Name
Type
Data Type
Description
Name:
patient.identifier
required
Type:
formData
Data Type:
string
Description:
The patient identifier consists of patient identifier namespace, also known as the system, and identifier, separated using a URL encoded | character i.e. %7c
.
Sample Value: ORION|AAAA-0124-8
Name:
Accept-Language
optional
Type:
header
Data Type:
string
Description:
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)
200
Returns a FHIR Bundle containing 0..* OperationOutcome resources and 0..* Flag resources
curl -X POST "https://api.orionhealth.io/fhir/1.0/Flag/_search" \
-H 'Accept-Language: undefined' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <Access Token>' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'patient.identifier=ORION%7CAAAA-0124-8'
GET /fhir/1.0/Flag/{id}
This method returns the Flag resource matching the requested resource ID.
Name
Type
Data Type
Description
Name:
id
required
Type:
path
Data Type:
string
Description:
The id of the Flag resource
Sample Value: shaSB36L37NUX4OGUNEDQBJVS6633CFZAUMORK4RL2T5BU3KXMYVSRA
Name:
Accept-Language
optional
Type:
header
Data Type:
string
Description:
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
200
Returns a Flag resource matching the requested resource ID.
404
No Flag resource found with the requested resource ID.
curl -X GET "https://api.orionhealth.io/fhir/1.0/Flag/shaSB36L37NUX4OGUNEDQBJVS6633CFZAUMORK4RL2T5BU3KXMYVSRA" \
-H 'Accept-Language: en-US' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <Access Token>'