FHIR Condition
Base Path: /fhir/4.0/Condition
Version: 1.1.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 the search criteria for a given patient.
- Retrieve a specific Condition resource based on its FHIR ID.
- Retrieve the history of a Condition resource based on its FHIR ID.
- Retrieve a specific version of a Condition resource based on its FHIR ID and Version ID.
- Support exporting resources via FHIR Bulk.
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 R4 release of the FHIR standard, for more information on this API refer to the official FHIR documentation.
Methods
Retrieve Conditions for a Patient
GET /fhir/4.0/Condition/
This method returns all conditions for the patient identified by patient resource id or patient identifier. Optionally filtering by the condition's category, code, date of onset and clinical status.
Parameters
Name
Type
Data Type
Description
Name:
patient
required
Type:
query
Data Type:
string
Description:
The patient resource id.
Note: You must either define the patient.identifier or patient, not both.
Sample Value: IFAUCQJNGAYTENBNHBAE6USJJ5HA
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.
Note: You must either define the patient.identifier or patient, not both.
Sample Value: ORION|AAA-00328-9
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: urn:text:TEST|Paracetamol
Name:
onset-date
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 gt, ge, lt, le and eq. 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: gt1990-01-01T01:00:00+13:00
Name:
clinical-status
optional
Type:
query
Data Type:
string
Description:
Filters the conditions to those that match the specified clinical status. Possible values are
- active
- recurrence
- relapse
- inactive
- remission
- resolved
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.
Sample Value: Orion%20Health%E2%84%A2%20R4%20HL7V2%20Generic%20Problems
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..
Sample Value: Orion%20Health%E2%84%A2%20R4%20HL7V2%20Generic%20Problems
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 json.
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 a FHIR Bundle containing 0.. OperationOutcome resources and 0.. Condition 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 specific Conditions for a Patient identified by a patient identifier
curl -X GET "https://developer-solution/fhir/4.0/Condition/?patient.identifier=ORION%7CAAA-00328-9" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='Retrieve Conditions for a Patient
POST /fhir/4.0/Condition/_search
This method returns all conditions for the patient identified by patient resource id or patient.identifier. Optionally filtering by the condition's category, code, date of onset and clinical status. 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
required
Type:
formData
Data Type:
string
Description:
The patient resource id.
Note: You must either define the patient.identifier or patient, not both.
Sample Value: IFAUCLJQGAZTEOBNHFAE6USJJ5HA
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.
Note: You must either define the patient.identifier or patient, not both.
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://hl7.org/fhir/diagnosis-role|AD
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-date
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 gt, ge, lt, le and eq. 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: gt1990-01-01T01:00:00+13:00
Name:
clinical-status
optional
Type:
formData
Data Type:
string
Description:
Filters the conditions to those that match the specified clinical status. Possible values are
- active
- recurrence
- relapse
- inactive
- remission
- resolved
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.
Sample Value: Orion%20Health%E2%84%A2%20R4%20HL7V2%20Generic%20Problems
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.
Sample Value: Orion%20Health%E2%84%A2%20R4%20HL7V2%20Generic%20Problems
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 a FHIR Bundle containing 0.. OperationOutcome resources and 0.. Condition 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 specific Conditions matching specified category for a Patient identified by a patient resource id
curl -X POST "https://developer-solution/fhir/4.0/Condition/_search" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8=' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'patient=IFAUCLJQGAZTEOBNHFAE6USJJ5HA' \
-d 'category=http://hl7.org/fhir/diagnosis-role%7CAD'Retrieve a single Condition
GET /fhir/4.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: shaZGJYRV6A3M54IBK4MBIRB3LM2XKCS4QYAWVYAIIJPPBAZMDBP7YQ
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 a Condition resource matching the the requested resource ID.
400
This code is returned when the FHIR ID is empty or not valid.
404
No Condition resource found with the requested resource ID.
Sample Requests
Retrieve conditions matching a specific resource id.
curl -X GET "https://developer-solution/fhir/4.0/Condition/shaZGJYRV6A3M54IBK4MBIRB3LM2XKCS4QYAWVYAIIJPPBAZMDBP7YQ" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='Retrieve a Condition's history
GET /fhir/4.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: shaCAMKP22N2RXATCDROITXGWFJCN7GOIQKMKLDPSQJOJRNY7PBXVYQ
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 a FHIR Bundle containing 1..* Condition resources matching the requested resource ID.
404
- No Condition resource found with the requested resource ID.
- The source providing the Condition resource is not capable of returning history of Condition resources.
Sample Requests
Retrieve the history of a condition identified a specific resource id.
curl -X GET "https://developer-solution/fhir/4.0/Condition/shaCAMKP22N2RXATCDROITXGWFJCN7GOIQKMKLDPSQJOJRNY7PBXVYQ/_history" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='Retrieve a Condition Resource by FHIR ID and Version ID
GET /fhir/4.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: shaCAMKP22N2RXATCDROITXGWFJCN7GOIQKMKLDPSQJOJRNY7PBXVYQ
Name:
versionid
required
Type:
path
Data Type:
string
Description:
The version of the Condition resource
Sample Value: 2
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 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 Requests
Retrieve conditions matching a specific resource id and version id.
curl -X GET "https://developer-solution/fhir/4.0/Condition/shaCAMKP22N2RXATCDROITXGWFJCN7GOIQKMKLDPSQJOJRNY7PBXVYQ/_history/2" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='