FHIR Condition
Base Path: /fhir/1.0/Condition
Version: 2.0.0
The FHIR Condition API allows you to look up a patient's conditions, problems or diagnoses that have been recognized by a clinician. The endpoint provides the ability to:
- Retrieve all Condition resources that match a search criteria for a given patient.
- Retrieve a specific Condition resource based on its resource ID.
The data returned in this API is subject to privacy and permissions settings, refer to the Working with Privacy guide to learn how this might affect your application.
The Condition 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 DSTU2 release of the FHIR standard, for more information on this API refer to the official FHIR documentation.
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 Conditions for a Patient
GET /fhir/1.0/Condition/
This method returns all conditions for the patient identified by patient.identifier. Optionally filtering by the condition's category, code, and date of onset.
Parameters
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:
category
optional
Type:
query
Data Type:
string
Description:
Filters the conditions to those belonging to a specific category. The category value consists of a coding system and a code separated using a URL encoded | character i.e. %7c.
Sample Value: http://snomed.info/sct|64572001
Name:
code
optional
Type:
query
Data Type:
string
Description:
Filters the conditions to those that match the specified code. The code value consists of a coding system and a code separated using a URL encoded | character i.e. %7c.
Sample Value: http://snomed.info/sct|44054006
Name:
onset
optional
Type:
query
Data Type:
string
Description:
Filters the conditions to those with an onset date on, before, or after a specific date or date-time.
The supported prefixes are >, >=, < and <=. 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.
Note: Date range searches are not supported in solutions containing Orion Health Problem List since the patient may have non-date onsets.
Sample Value: >1990-01-01T01:00:00+13:00
Responses
200
Returns a FHIR Bundle containing 0.. OperationOutcome resources and 0.. Condition resources
400
Bad Request. Date range searches are not supported in solutions containing Orion Health Problem List since the patient may have non-date onsets
Sample Requests
Get all Conditions for a Patient
curl -X GET "https://api.orionhealth.io/fhir/1.0/Condition/?patient.identifier=ORION%7CAAAA-0124-8" \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <Access Token>'Search for specific Conditions for a Patient
curl -X GET "https://api.orionhealth.io/fhir/1.0/Condition/?patient.identifier=ORION%7CAAAA-0124-8&category=http://snomed.info/sct%7C64572001&code=http://snomed.info/sct%7C44054006" \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <Access Token>'Get Conditions for a Patient
POST /fhir/1.0/Condition/_search
This method returns all conditions for the patient identified by patient.identifier. Optionally filtering by the condition's category, code, and date of onset. This is the secure alternative to the GET search.
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:
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:
category
optional
Type:
formData
Data Type:
string
Description:
Filters the conditions to those belonging to a specific category. The category value consists of a coding system and a code separated using a URL encoded | character i.e. %7c.
Sample Value: http://snomed.info/sct|64572001
Name:
code
optional
Type:
formData
Data Type:
string
Description:
Filters the conditions to those that match the specified code. The code value consists of a coding system and a code separated using a URL encoded | character i.e. %7c.
Sample Value: http://snomed.info/sct|44054006
Name:
onset
optional
Type:
formData
Data Type:
string
Description:
Filters the conditions to those with an onset date on, before, or after a specific date or date-time.
The supported prefixes are >, >=, < and <=. 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.
Note: Date range searches are not supported in solutions containing Orion Health Problem List since the patient may have non-date onsets.
Sample Value: >1990-01-01T01:00:00+13:00
Responses
200
Returns a FHIR Bundle containing 0.. OperationOutcome resources and 0.. Condition resources
400
Bad Request. Date range searches are not supported in solutions containing Orion Health Problem List since the patient may have non-date onsets
Sample Requests
Get all Conditions for a Patient
curl -X POST "https://api.orionhealth.io/fhir/1.0/Condition/_search" \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <Access Token>' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'patient.identifier=ORION%7CAAAA-0124-8'Search for specific Conditions for a Patient
curl -X POST "https://api.orionhealth.io/fhir/1.0/Condition/_search" \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <Access Token>' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'patient.identifier=ORION%7CAAAA-0124-8' \
-d 'category=http://snomed.info/sct%7C64572001' \
-d 'code=http://snomed.info/sct%7C44054006'Retrieve a single Condition
GET /fhir/1.0/Condition/{id}
This method returns the Condition 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 Condition resource
Sample Value: JVVGW6CNIREXOTKEIU6UAVKGJJBUY23MIV6FKMLMKRMDARJ5IA
Responses
200
Returns a Condition resource matching the the requested resource ID.
404
No Condition resource found with the requested resource ID.
Sample Request
curl -X GET "https://api.orionhealth.io/fhir/1.0/Condition/JVVGW6CNIREXOTKEIU6UAVKGJJBUY23MIV6FKMLMKRMDARJ5IA" \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <Access Token>'Get a Condition's history
GET /fhir/1.0/Condition/{id}/_history
This method returns the change history for a Condition resource matching the requested resource ID. Condition 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 Condition can be found, which includes cases where:
- The specified Condition resource cannot be found.
- The data source for the Condition 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 Condition resource
Sample Value: JVVGW6CNIREXOTKEIU6UAVKGJJBUY23MIV6FKMLMKRMDARJ5IA
Responses
200
Returns a FHIR Bundle containing 0..* Condition resources matching the requested resource ID.
Sample Request
curl -X GET "https://api.orionhealth.io/fhir/1.0/Condition/JVVGW6CNIREXOTKEIU6UAVKGJJBUY23MIV6FKMLMKRMDARJ5IA/_history" \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <Access Token>'Retrieve a specific version of a Condition
GET /fhir/1.0/Condition/{id}/_history/{versionid}
This method returns a specific version of the Condition 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 Condition resource
Sample Value: JVVGW6CNIREXOTKEIU6UAVKGJJBUY23MIV6FKMLMKRMDARJ5IA
Name:
versionid
required
Type:
path
Data Type:
string
Description:
The version of the Condition resource
Responses
200
Returns a Condition resource matching the the requested resource ID and version id.
404
- No Condition resource found with the requested resource ID.
- The version id specified does not exist for the Condition resource with the requested resource ID.
- The source providing the Condition resource is not capable of returning history of Condition resources.
Sample Request
curl -X GET "https://api.orionhealth.io/fhir/1.0/Condition/JVVGW6CNIREXOTKEIU6UAVKGJJBUY23MIV6FKMLMKRMDARJ5IA/_history/0" \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <Access Token>'