FHIR Condition

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.
• In addition to having the required patient.identifier or patient, you can defined chained patient elements to define filters on the reference, each of the chained parameters can specify multiple comma separated values.

Sample format of the query is

• patient.identifier={namespace}|{identifier}
• patient.identifier={namespace}|{identifier} & patient.gender=male & patient.birthdate=2002-05-01

Sample Value: ORION|AAA-00315-7

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.

• In addition to having the required patient.identifier or patient, you can defined chained patient elements to define filters on the reference, each of the chained parameters can specify multiple comma separated values.

  Sample format of the query is

  • patient={patient FHIRID}
  • patient={patient FHIRID} & patient.gender=male & patient.birthdate=2002-05-01

Sample Value: patient=IFAUCQJNGAYTENBNHBAE6USJJ5HA

Name:

category

optional

Type:

query

Data Type:

array

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

Note: Supports passing in a comma-separated list of values.

Sample Value: http://snomed.info/sct|64572001

Name:

code

optional

Type:

query

Data Type:

array

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

Note: Supports passing in a comma-separated list of values.

Sample Value: urn:text:TEST|Paracetamol

Name:

onset-date

optional

Type:

query

Data Type:

array

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.

The format of the query is

• onset-date=gt{dateTimeValue}
• onset-date=ge{dateTimeValue}&onset-date=le{dateTimeValue}

Sample Value: gt1990-01-01T01:00:00+13:00

Name:

onset-age

optional

Type:

query

Data Type:

array

Description:

Filters the conditions by onset age or age range. The onset-age value consists of a prefix, value, unit system and a unit sperated by a URL encoded | character i.e. %7c The supported prefixes are gt, ge, lt, le and eq. If no prefix is used, exact matching is implied.

The format of the query is

• onset-age={prefix}}{value}|{units system}|{unit code}
• onset-age={prefix}}{value}|{units system}|{unit code} & {prefix}}{value}|{units system}|{unit code}

Sample Value: onset-age=gt5|http://unitsofmeasure.org|wk & length=lt24|http://unitsofmeasure.org|wk

Name:

onset-info

optional

Type:

query

Data Type:

array

Description:

Filters the conditions by onset string match.

Note: Supports passing in a comma-separated list of values.

Sample Value: onset-info=last year, 2023

Name:

clinical-status

optional

Type:

query

Data Type:

array

Description:

Filters the conditions to those that match the specified clinical status. The clinical-status may consists of a coding system and a code separated using a URL encoded | character i.e. %7c The supported values are:

• active
• recurrence
• relapse
• inactive
• remission
• resolved

Note:

• Supports passing in a comma-separated list of values.
• If a clinical-status system is specified it can only be http://terminology.hl7.org/CodeSystem/condition-clinical

Sample Value: active

Name:

abatement-date

optional

Type:

query

Data Type:

array

Description:

Filters the conditions to those with an abatement 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.

The format of the query is

• abatement-date=gt{dateTimeValue}
• abatement-date=ge{dateTimeValue}&abatement-date=le{dateTimeValue}

Sample Value: gt1990-01-01T01:00:00+13:00

Name:

abatement-age

optional

Type:

query

Data Type:

array

Description:

Filters the conditions by abatement age or age range. The abatement-age value consists of a prefix, value, unit system and a unit sperated by a URL encoded | character i.e. %7c The supported prefixes are gt, ge, lt, le and eq. If no prefix is used, exact matching is implied.

The format of the query is

• abatement-age={prefix}}{value}|{units system}|{unit code}
• abatement-age={prefix}}{value}|{units system}|{unit code} & {prefix}}{value}|{units system}|{unit code}

Sample Value: abatement-age=gt5|http://unitsofmeasure.org|wk & length=lt24|http://unitsofmeasure.org|wk

Name:

abatement-string

optional

Type:

query

Data Type:

array

Description:

Filters the conditions by abatement string match.

Note: Supports passing in a comma-separated list of values.

Sample Value: abatement-string=last year, 2023

Name:

verification-status

optional

Type:

query

Data Type:

array

Description:

Filters the conditions to those that match the specified verification status. The verification-status may consists of a coding system and a code separated using a URL encoded | character i.e. %7c The supported values are:

• unconfirmed
• provisional
• differential
• confirmed
• refuted
• entered-in-error

Note:

• Supports passing in a comma-separated list of values.
• If a clinical-status system is specified it can only be http://terminology.hl7.org/CodeSystem/condition-ver-status

Sample Value: verifiction-status=differential , confirmed ,provisional

Name:

recorded-date

optional

Type:

query

Data Type:

array

Description:

Filters the conditions to those with a recorded 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.

The format of the query is

• recorded-date=gt{dateTimeValue}
• recorded-date=ge{dateTimeValue}&recorded-date=le{dateTimeValue}

Sample Value: gt1990-01-01T01:00:00+13:00

Name:

severity

optional

Type:

query

Data Type:

array

Description:

Filters the conditions by the Condition severity. The severity value consists of a coding system and a code separated using a URL encoded | character i.e. %7c

Note: Supports passing in a comma-separated list of values.

Sample Value: severity=http://snomed.info/sct|371924009 , http://snomed.info/sct|255604002

Name:

body-site

optional

Type:

query

Data Type:

array

Description:

Filters the conditions to those with the specified anatomical location. The body-site value consists of a coding system and a code separated using a URL encoded | character i.e. %7c

Note: Supports passing in a comma-separated list of values.

Sample Value: body-site=http://snomed.info/sct|38266002

Name:

evidence

optional

Type:

query

Data Type:

array

Description:

Filters the conditions to those with a specific manifestation or symptom code. The evidence value is matched againt the Condition.evidence.code. The evidence value consists of a coding system and a code separated using a URL encoded | character i.e. %7c

Note: Supports passing in a comma-separated list of values.

Sample Value: evidence=http://snomed.info/sct|258710007, http://snomed.info/sct|169069000

Name:

evidence-detail

optional

Type:

query

Data Type:

array

Description:

Filters Conditions by the supported information reference found elsewhere, identified by their Condition.evidence.detail reference.

Note: evidence-detail can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.

Sample Value: evidence-detail:DiagnosticReport.code=http://loinc.org/|22735-5,22702-5

Name:

stage

optional

Type:

query

Data Type:

array

Description:

Filters the conditions to those belonging to with the requested stage summary code. The stage value is matched againt the Condition.stage.summary The stage value consists of a coding system and a code separated using a URL encoded | character i.e. %7c

Note: Supports passing in a comma-separated list of values.

Sample Value: stage=http://snomed.info/sct|786005, http://snomed.info/sct|1523005

Name:

identifier

optional

Type:

query

Data Type:

array

Description:

Filters Conditions by the identifier associated with this condition.

Note: The identifier can be a single item or a comma separated list of identifiers. Each identifier is defined by system and value , separated using a URL encoded | character i.e. %7c.

Sample Value: urn:oid:1.3.4.5.6.7|2345234234234, urn:text:sysA|2345

Name:

encounter

optional

Type:

query

Data Type:

array

Description:

Filters Conditions by the referenced encounter, identified by their Condition.encounter reference.

Note: encounter can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.

Sample Value: encounter.identifier=SYS_A|visti123

Name:

asserter

optional

Type:

query

Data Type:

array

Description:

Filters Conditions by who asserts the Condition, identified by their Condition.asserter reference.

Note: asserter can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.

Sample Value: asserter:Practitioner.family=Smith&asserter:Practitioner.given=Bob,Robert

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: -include-sources=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: -exclude-sources=Orion%20Health%E2%84%A2%20R4%20HL7V2%20Generic%20Problems

Name:

_summary

optional

Type:

query

Data Type:

string

Description:

Instructs the server to return a subset of the resource, reducing the size of the reponse payload. Possible values are

• true: return summaries only
• false: return full resources
• count: return the count of search matches
• text: return only the text, id, meta, and top-level mandatory elements
• data: remove the text element

Sample Value: true

Name:

_lastUpdated

optional

Type:

query

Data Type:

array

Description:

Filters based on when the resource version was last changed, before, or after a specific date, date-time, or date range. 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.

The format of the query is

• _lastUpdated=gt{dateTimeValue}
• _lastUpdated=ge{dateTimeValue}&_lastUpdated=le{dateTimeValue}

Sample Value: ge2012-01-01T01:00:00+13:00

Name:

_elements

optional

Type:

query

Data Type:

array

Description:

Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.

Sample Value: _elements=code,category,severity,_elements:exclude=*.extension,*.encounter

Name:

-cursor

optional

Type:

query

Data Type:

string

Description:

A server internal parameter to navigate different pages.

This parameter is returned by the server as part of the Bundle 'next' link of a paginated query. And is used to retrieve the next page

Name:

_count

optional

Type:

query

Data Type:

integer

Description:

Limit the number of match results to the specified _count. When _count is specified, the query will be paginated, and only _count or less results will be returned.

The returned bundle may contain a next link if more results could be available.

Sample Value: 30

Name:

_sort

optional

Type:

query

Data Type:

array

Description:

Request which order results should be returned in.

Supported _sort parameters are:

• onset-date to sort by Condition.onset ascending
• -onset-date to sort by Condition.onset descending
• recorded-date to sort by Condition.recordedDate ascending
• -recorded-date to sort by Condition.recordedDate descending
• abatement-date to sort by Condition.abatement ascending
• -abatement-date to sort by Condition.abatement descending
• _lastUpdated to sort by Condition.Meta.lastUpdated ascending
• -_lastUpdatedto sort by Condition.Meta.lastUpdated descending

You can use any combination of the parameters

Default Value: -onset-date

Sample Value: _sort=-onset-date,_sort=-onset-date, -_lastUpdated, -recorded-date

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.

Sample Value: adUEctf6urd

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml. If both _format and Accept are specified, _format takes precedence.

Default Value: application/json

Sample Value: application/json

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

Specifies 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

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.

Default Value: json

Sample Value: json

Name:

_pretty

optional

Type:

query

Data Type:

string

Description:

Ask for a pretty printed response for human convenience.

Default Value: true

Sample Value: true

Name:

CSRF-Token

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. The csrfToken from the OHP session must be included in this header.

System will validate the token and reject the request if the token is invalid or not present.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.

Name:

X-Send-Open-API

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.

System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.

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.

Note:

• You must either define the patient.identifier or patient, not both.
• In addition to having the required patient.identifier or patient, you can defined chained patient elements to define filters on the reference, each of the chained parameters can specify multiple comma separated values.

Sample format of the query is

• patient.identifier={namespace}|{identifier}
• patient.identifier={namespace}|{identifier} & patient.gender=male & patient.birthdate=2002-05-01

Sample Value: ORION|AAA-00315-7

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.

• In addition to having the required patient.identifier or patient, you can defined chained patient elements to define filters on the reference, each of the chained parameters can specify multiple comma separated values.

  Sample format of the query is

  • patient={patient FHIRID}
  • patient={patient FHIRID} & patient.gender=male & patient.birthdate=2002-05-01

Sample Value: IFAUCQJNGAYTENBNHBAE6USJJ5HA

Name:

category

optional

Type:

formData

Data Type:

array

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

Note: Supports passing in a comma-separated list of values.

Sample Value: http://hl7.org/fhir/diagnosis-role|AD

Name:

code

optional

Type:

formData

Data Type:

array

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

Note: Supports passing in a comma-separated list of values.

Sample Value: urn:text:TEST|Paracetamol

Name:

onset-date

optional

Type:

formData

Data Type:

array

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.

The format of the query is

• onset-date=gt{dateTimeValue}
• onset-date=ge{dateTimeValue}&onset-date=le{dateTimeValue}

Sample Value: gt1990-01-01T01:00:00+13:00

Name:

onset-age

optional

Type:

formData

Data Type:

array

Description:

Filters the conditions by onset age or age range. The onset-age value consists of a prefix, value, unit system and a unit sperated by a URL encoded | character i.e. %7c The supported prefixes are gt, ge, lt, le and eq. If no prefix is used, exact matching is implied.

The format of the query is

• onset-age={prefix}}{value}|{units system}|{unit code}
• onset-age={prefix}}{value}|{units system}|{unit code} & {prefix}}{value}|{units system}|{unit code}

Sample Value: onset-age=gt5|http://unitsofmeasure.org|wk & length=lt24|http://unitsofmeasure.org|wk

Name:

onset-info

optional

Type:

formData

Data Type:

array

Description:

Filters the conditions by onset string match.

Note: Supports passing in a comma-separated list of values.

Sample Value: onset-info=last year, 2023

Name:

clinical-status

optional

Type:

formData

Data Type:

array

Description:

Filters the conditions to those that match the specified clinical status. The clinical-status may consists of a coding system and a code separated using a URL encoded | character i.e. %7c The supported values are:

• active
• recurrence
• relapse
• inactive
• remission
• resolved

Note:

• Supports passing in a comma-separated list of values.
• If a clinical-status system is specified it can only be http://terminology.hl7.org/CodeSystem/condition-clinical

Sample Value: active

Name:

abatement-date

optional

Type:

formData

Data Type:

array

Description:

Filters the conditions to those with an abatement 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.

The format of the query is

• abatement-date=gt{dateTimeValue}
• abatement-date=ge{dateTimeValue}&abatement-date=le{dateTimeValue}

Sample Value: gt1990-01-01T01:00:00+13:00

Name:

abatement-age

optional

Type:

formData

Data Type:

array

Description:

Filters the conditions by abatement age or age range. The abatement-age value consists of a prefix, value, unit system and a unit sperated by a URL encoded | character i.e. %7c The supported prefixes are gt, ge, lt, le and eq. If no prefix is used, exact matching is implied.

The format of the query is

• abatement-age={prefix}}{value}|{units system}|{unit code}
• abatement-age={prefix}}{value}|{units system}|{unit code} & {prefix}}{value}|{units system}|{unit code}

Sample Value: abatement-age=gt5|http://unitsofmeasure.org|wk & length=lt24|http://unitsofmeasure.org|wk

Name:

abatement-string

optional

Type:

formData

Data Type:

array

Description:

Filters the conditions by abatement string match.

Note: Supports passing in a comma-separated list of values.

Sample Value: abatement-string=last year, 2023

Name:

verification-status

optional

Type:

formData

Data Type:

array

Description:

Filters the conditions to those that match the specified verification status. The verification-status may consists of a coding system and a code separated using a URL encoded | character i.e. %7c The supported values are:

• unconfirmed
• provisional
• differential
• confirmed
• refuted
• entered-in-error

Note:

• Supports passing in a comma-separated list of values.
• If a clinical-status system is specified it can only be http://terminology.hl7.org/CodeSystem/condition-ver-status

Sample Value: verifiction-status=differential , confirmed ,provisional

Name:

recorded-date

optional

Type:

formData

Data Type:

array

Description:

Filters the conditions to those with a recorded 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.

The format of the query is

• recorded-date=gt{dateTimeValue}
• recorded-date=ge{dateTimeValue}&recorded-date=le{dateTimeValue}

Sample Value: gt1990-01-01T01:00:00+13:00

Name:

severity

optional

Type:

formData

Data Type:

array

Description:

Filters the conditions by the Condition severity. The severity value consists of a coding system and a code separated using a URL encoded | character i.e. %7c

Note: Supports passing in a comma-separated list of values.

Sample Value: severity=http://snomed.info/sct|371924009 , http://snomed.info/sct|255604002

Name:

body-site

optional

Type:

formData

Data Type:

array

Description:

Filters the conditions to those with the specified anatomical location. The body-site value consists of a coding system and a code separated using a URL encoded | character i.e. %7c

Note: Supports passing in a comma-separated list of values.

Sample Value: body-site=http://snomed.info/sct|38266002

Name:

evidence

optional

Type:

formData

Data Type:

array

Description:

Filters the conditions to those with a specific manifestation or symptom code. The evidence value is matched againt the Condition.evidence.code. The evidence value consists of a coding system and a code separated using a URL encoded | character i.e. %7c

Note: Supports passing in a comma-separated list of values.

Sample Value: evidence=http://snomed.info/sct|258710007, http://snomed.info/sct|169069000

Name:

evidence-detail

optional

Type:

formData

Data Type:

array

Description:

Filters Conditions by the supported information reference found elsewhere, identified by their Condition.evidence.detail reference.

Note: evidence-detail can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.

Sample Value: evidence-detail:DiagnosticReport.code=http://loinc.org/|22735-5,22702-5

Name:

stage

optional

Type:

formData

Data Type:

array

Description:

Filters the conditions to those belonging to with the requested stage summary code. The stage value is matched againt the Condition.stage.summary The stage value consists of a coding system and a code separated using a URL encoded | character i.e. %7c

Note: Supports passing in a comma-separated list of values.

Sample Value: stage=http://snomed.info/sct|786005, http://snomed.info/sct|1523005

Name:

identifier

optional

Type:

formData

Data Type:

array

Description:

Filters Conditions by the identifier associated with this condition.

Note: The identifier can be a single item or a comma separated list of identifiers. Each identifier is defined by system and value , separated using a URL encoded | character i.e. %7c.

Sample Value: urn:oid:1.3.4.5.6.7|2345234234234, urn:text:sysA|2345

Name:

encounter

optional

Type:

formData

Data Type:

array

Description:

Filters Conditions by the referenced encounter, identified by their Condition.encounter reference.

Note: encounter can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.

Sample Value: encounter.identifier=SYS_A|visti123

Name:

asserter

optional

Type:

formData

Data Type:

array

Description:

Filters Conditions by who asserts the Condition, identified by their Condition.asserter reference.

Note: asserter can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.

Sample Value: asserter:Practitioner.family=Smith&asserter:Practitioner.given=Bob,Robert

Name:

-include-sources

optional

Type:

formData

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: -include-sources=Orion%20Health%E2%84%A2%20R4%20HL7V2%20Generic%20Problems

Name:

-exclude-sources

optional

Type:

formData

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: -exclude-sources=Orion%20Health%E2%84%A2%20R4%20HL7V2%20Generic%20Problems

Name:

_summary

optional

Type:

formData

Data Type:

string

Description:

Instructs the server to return a subset of the resource, reducing the size of the reponse payload. Possible values are

• true: return summaries only
• false: return full resources
• count: return the count of search matches
• text: return only the text, id, meta, and top-level mandatory elements
• data: remove the text element

Sample Value: true

Name:

_lastUpdated

optional

Type:

formData

Data Type:

array

Description:

Filters based on when the resource version was last changed, before, or after a specific date, date-time, or date range. 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.

The format of the query is

• _lastUpdated=gt{dateTimeValue}
• _lastUpdated=ge{dateTimeValue}&_lastUpdated=le{dateTimeValue}

Sample Value: ge2012-01-01T01:00:00+13:00

Name:

_elements

optional

Type:

formData

Data Type:

array

Description:

Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.

Sample Value: _elements=code,category,severity,_elements:exclude=*.extension,*.encounter

Name:

-cursor

optional

Type:

formData

Data Type:

string

Description:

A server internal parameter to navigate different pages.

This parameter is returned by the server as part of the Bundle 'next' link of a paginated query. And is used to retrieve the next page

Name:

_count

optional

Type:

formData

Data Type:

integer

Description:

Limit the number of match results to the specified _count. When _count is specified, the query will be paginated, and only _count or less results will be returned.

The returned bundle may contain a next link if more results could be available.

Sample Value: 30

Name:

_sort

optional

Type:

formData

Data Type:

array

Description:

Request which order results should be returned in.

Supported _sort parameters are:

• onset-date to sort by Condition.onset ascending
• -onset-date to sort by Condition.onset descending
• recorded-date to sort by Condition.recordedDate ascending
• -recorded-date to sort by Condition.recordedDate descending
• abatement-date to sort by Condition.abatement ascending
• -abatement-date to sort by Condition.abatement descending
• _lastUpdated to sort by Condition.Meta.lastUpdated ascending
• -_lastUpdatedto sort by Condition.Meta.lastUpdated descending

You can use any combination of the parameters

Default Value: -onset-date

Sample Value: _sort=-onset-date,_sort=-onset-date, -_lastUpdated, -recorded-date

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.

Sample Value: adUEctf6urd

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml. If both _format and Accept are specified, _format takes precedence.

Default Value: application/json

Sample Value: application/json

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

Specifies 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

Name:

_format

optional

Type:

formData

Data Type:

string

Description:

Media type of the response. It takes precedence over the Accept header. Possible values are json and xml.

Default Value: json

Sample Value: json

Name:

_pretty

optional

Type:

formData

Data Type:

string

Description:

Ask for a pretty printed response for human convenience.

Default Value: true

Sample Value: true

Name:

CSRF-Token

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. The csrfToken from the OHP session must be included in this header.

System will validate the token and reject the request if the token is invalid or not present.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.

Name:

X-Send-Open-API

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.

System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.

Name:

id

required

Type:

path

Data Type:

string

Description:

The id of the Condition resource

Sample Value: shaZGJYRV6A3M54IBK4MBIRB3LM2XKCS4QYAWVYAIIJPPBAZMDBP7YQ

Name:

_elements

optional

Type:

query

Data Type:

array

Description:

Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.

Sample Value: _elements=code,category,severity,_elements:exclude=*.extension,*.encounter

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.

Sample Value: adUEctf6urd

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml. If both _format and Accept are specified, _format takes precedence.

Default Value: application/json

Sample Value: application/json

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

Specifies 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

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.

Default Value: json

Sample Value: json

Name:

_pretty

optional

Type:

query

Data Type:

string

Description:

Ask for a pretty printed response for human convenience.

Default Value: true

Sample Value: true

Name:

CSRF-Token

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. The csrfToken from the OHP session must be included in this header.

System will validate the token and reject the request if the token is invalid or not present.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.

Name:

X-Send-Open-API

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.

System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.

Name:

id

required

Type:

path

Data Type:

string

Description:

The id of the Condition resource

Sample Value: shaCAMKP22N2RXATCDROITXGWFJCN7GOIQKMKLDPSQJOJRNY7PBXVYQ

Name:

_elements

optional

Type:

query

Data Type:

array

Description:

Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.

Sample Value: _elements=code,category,severity,_elements:exclude=*.extension,*.encounter

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.

Sample Value: adUEctf6urd

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml. If both _format and Accept are specified, _format takes precedence.

Default Value: application/json

Sample Value: application/json

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

Specifies 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

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.

Default Value: json

Sample Value: json

Name:

_pretty

optional

Type:

query

Data Type:

string

Description:

Ask for a pretty printed response for human convenience.

Default Value: true

Sample Value: true

Name:

CSRF-Token

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. The csrfToken from the OHP session must be included in this header.

System will validate the token and reject the request if the token is invalid or not present.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.

Name:

X-Send-Open-API

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.

System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.

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:

_elements

optional

Type:

query

Data Type:

array

Description:

Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.

Sample Value: _elements=code,category,severity,_elements:exclude=*.extension,*.encounter

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.

Sample Value: adUEctf6urd

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml. If both _format and Accept are specified, _format takes precedence.

Default Value: application/json

Sample Value: application/json

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

Specifies 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

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.

Default Value: json

Sample Value: json

Name:

_pretty

optional

Type:

query

Data Type:

string

Description:

Ask for a pretty printed response for human convenience.

Default Value: true

Sample Value: true

Name:

CSRF-Token

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. The csrfToken from the OHP session must be included in this header.

System will validate the token and reject the request if the token is invalid or not present.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.

Name:

X-Send-Open-API

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.

System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.