FHIR CarePlan

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: MEYGKZDEGUYTSQCPJBBVA

Name:

activity-code

optional

Type:

query

Data Type:

array

Description:

Filters the care plans to those that match the specified activity 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: http://snomed.info/sct|104001

Name:

activity-date

optional

Type:

query

Data Type:

array

Description:

Filters the care plans to those with a scheduledPeriod or scheduledTiming on, before, or after a specific date, date-time, or date range. The supported prefixes (for Period or Timing type) 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

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

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

Name:

activity-reference

optional

Type:

query

Data Type:

array

Description:

Filters the CarePlans to those that include a specified activity reference, identified by their CarePlan.activity.reference reference.

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

Sample Value: ServiceRequest/HE2DKNRZFU2DKNRVIBJVSU27IE

Name:

based-on

optional

Type:

query

Data Type:

array

Description:

Filters the CarePlans to those that are based on the specified CarePlan, identified by their CarePlan.basedOn reference.

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

Sample Value: CarePlan/shaO74NZR7CTOEKDLODIFSODJS4DLRWBEJ6XIO4PGOGJDCTSMCWVNSQ

Name:

care-team

optional

Type:

query

Data Type:

array

Description:

Filters the CarePlans to those that include a specified CareTeam, identified by their CarePlan.careTeam reference

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

Sample Value: CareTeam/GE3TAMZWHA3WKMSAKNMVGX2B

Name:

category

optional

Type:

query

Data Type:

array

Description:

Filters the CarePlans to ones with a team type that matches the specified 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: urn:oid:2.16.840.1.113883.12.74|IMM

Name:

condition

optional

Type:

query

Data Type:

array

Description:

Filters the CarePlans to those that include a specified Condition, identified by their CarePlan.condition reference

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

Sample Value: condition.bodySite=http://snomed.info/sct|774007&condition.clinicalStatus=active

Name:

date

optional

Type:

query

Data Type:

array

Description:

Filters the CarePlans to those with a date Period that overlaps 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

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

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

Name:

encounter

optional

Type:

query

Data Type:

array

Description:

Filters CarePlans by the referenced encounter, identified by their CarePlan.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/GJFIFIDHFSKDLJGIUSDDSU

Name:

goal

optional

Type:

query

Data Type:

array

Description:

Filters CarePlans by the referenced goal, identified by their CarePlan.goal reference.

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

Sample Value: Goal/GE4DMYJRHA4GKQCPJHVAC

Name:

identifier

optional

Type:

query

Data Type:

array

Description:

Filters CarePlans by the identifier associated with this CarePlan.

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: System%7C9d3930f4-7a8c-4104-ba1f-1ea28c5f3e96

Name:

instantiates-canonical

optional

Type:

query

Data Type:

array

Description:

Filters CarePlans by the referenced FHIR protocol or definition it instantiates, identified by their CarePlan.instantiatesCanonical reference.

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

Sample Value: PlanDefinition/AT4DSTJRJNTYFQCPJ6QYP

Name:

instantiates-uri

optional

Type:

query

Data Type:

array

Description:

Filters CarePlans by the uri of the external protocol or definition it instantiates, identified by their CarePlan.instantiatesCanonical uri.

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

Sample Value: http://snomed.info/sct/293847

Name:

intent

optional

Type:

query

Data Type:

array

Description:

Filters the CarePlans by the intent. The intent may consist of a coding system and a code separated using a URL encoded | character i.e. %7c

The supported values are:

• proposal
• plan
• order
• option

Note:

• If an intent system is specified only http://hl7.org/fhir/request-intent can be used.
• Supports passing in a comma-separated list of values.

Sample Value: order

Name:

part-of

optional

Type:

query

Data Type:

array

Description:

Filters the CarePlans to those that are part of the specified CarePlan, identified by their CarePlan.partOf reference.

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

Sample Value: CarePlan/shaO74NZR7CTOEKDLODIFSODJS4DLRWBEJ6XIO4PGOGJDCTSMCWVNSQ

Name:

performer

optional

Type:

query

Data Type:

array

Description:

Filters CarePlans by the requested performer, identified by their CarePlan.performer reference.

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

Sample Value: Practitioner/RWBEJ6XIO4PGOGJDCTSMCWVNSQ

Name:

replaces

optional

Type:

query

Data Type:

array

Description:

Filters CarePlans by the CarePlan it replaces, identified by their CarePlan.replaces reference.

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

Sample Value: CarePlan/shaO74NZR7CTOEKDLODIFSODJS4DLRWBEJ6XIO4PGOGJDCTSMCWVNSQ

Name:

status

optional

Type:

query

Data Type:

array

Description:

Filters the CarePlans to those that match the specified status. The status may consists of a coding system and a code separated using a URL encoded | character i.e. %7c

The supported values are:

• active
• on-hold
• cancelled
• completed
• entered-in-error
• revoked
• draft
• unknown

Note:

• If a status system is specified only http://hl7.org/fhir/request-status can be used.
• Supports passing in a comma-separated list of values.

Sample Value: active

Name:

created

optional

Type:

query

Data Type:

array

Description:

Filters the CarePlans to those with a created date on, 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

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

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

Name:

title

optional

Type:

query

Data Type:

array

Description:

Filters the CarePlans to those that include a specified string within the CarePlan.title.

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

Sample Value: pain

Name:

author

optional

Type:

query

Data Type:

array

Description:

Filters CarePlans by the designated responsible party, identified by their CarePlan.author reference.

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

Sample Value: Practitioner/AUNKCOKM758HDUSPPVNSQ

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%20CDR%20CarePlans

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%20CDR%20CarePlans

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:

_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:

_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=date,encounter,status,_elements:exclude=*.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:

• date to sort by CarePlan.period ascending
• -date to sort by CarePlan.period descending
• created to sort by CarePlan.created ascending
• -created to sort by CarePlan.created descending
• title to sort by CarePlan.title ascending
• -title to sort by CarePlan.title descending
• _lastUpdated to sort by CarePlan.Meta.lastUpdated ascending
• -_lastUpdatedto sort by CarePlan.Meta.lastUpdated descending

You can use any combination of the parameters

Default Value: -date

Sample Value: _sort=-date,_sort=-date,-_lastUpdated,-created

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: xml

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:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.

Sample Value: adUEctf6urd

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:

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/json

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: MEYGKZDEGUYTSQCPJBBVA

Name:

activity-code

optional

Type:

formData

Data Type:

array

Description:

Filters the care plans to those that match the specified activity 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: http://snomed.info/sct|104001

Name:

activity-date

optional

Type:

formData

Data Type:

array

Description:

Filters the care plans to those with a scheduledPeriod or scheduledTiming on, before, or after a specific date, date-time, or date range. The supported prefixes (for Period or Timing type) 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

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

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

Name:

activity-reference

optional

Type:

formData

Data Type:

array

Description:

Filters the CarePlans to those that include a specified activity reference, identified by their CarePlan.activity.reference reference.

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

Sample Value: ServiceRequest/HE2DKNRZFU2DKNRVIBJVSU27IE

Name:

based-on

optional

Type:

formData

Data Type:

array

Description:

Filters the CarePlans to those that are based on the specified CarePlan, identified by their CarePlan.basedOn reference.

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

Sample Value: CarePlan/shaO74NZR7CTOEKDLODIFSODJS4DLRWBEJ6XIO4PGOGJDCTSMCWVNSQ

Name:

care-team

optional

Type:

formData

Data Type:

array

Description:

Filters the CarePlans to those that include a specified CareTeam, identified by their CarePlan.careTeam reference

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

Sample Value: CareTeam/GE3TAMZWHA3WKMSAKNMVGX2B

Name:

category

optional

Type:

formData

Data Type:

array

Description:

Filters the CarePlans to ones with a team type that matches the specified 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: urn:oid:2.16.840.1.113883.12.74|IMM

Name:

condition

optional

Type:

formData

Data Type:

array

Description:

Filters the CarePlans to those that include a specified Condition, identified by their CarePlan.condition reference

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

Sample Value: condition.bodySite=http://snomed.info/sct|774007&condition.clinicalStatus=active

Name:

date

optional

Type:

formData

Data Type:

array

Description:

Filters the CarePlans to those with a date Period that overlaps 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

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

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

Name:

encounter

optional

Type:

formData

Data Type:

array

Description:

Filters CarePlans by the referenced encounter, identified by their CarePlan.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/GJFIFIDHFSKDLJGIUSDDSU

Name:

goal

optional

Type:

formData

Data Type:

array

Description:

Filters CarePlans by the referenced goal, identified by their CarePlan.goal reference.

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

Sample Value: Goal/GE4DMYJRHA4GKQCPJHVAC

Name:

identifier

optional

Type:

formData

Data Type:

array

Description:

Filters CarePlans by the identifier associated with this CarePlan.

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: System%7C9d3930f4-7a8c-4104-ba1f-1ea28c5f3e96

Name:

instantiates-canonical

optional

Type:

formData

Data Type:

array

Description:

Filters CarePlans by the referenced FHIR protocol or definition it instantiates, identified by their CarePlan.instantiatesCanonical reference.

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

Sample Value: PlanDefinition/AT4DSTJRJNTYFQCPJ6QYP

Name:

instantiates-uri

optional

Type:

formData

Data Type:

array

Description:

Filters CarePlans by the uri of the external protocol or definition it instantiates, identified by their CarePlan.instantiatesCanonical uri.

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

Sample Value: http://snomed.info/sct/293847

Name:

intent

optional

Type:

formData

Data Type:

array

Description:

Filters the CarePlans by the intent. The intent may consist of a coding system and a code separated using a URL encoded | character i.e. %7c

The supported values are:

• proposal
• plan
• order
• option

Note:

• If an intent system is specified only http://hl7.org/fhir/request-intent can be used.
• Supports passing in a comma-separated list of values.

Sample Value: order

Name:

part-of

optional

Type:

formData

Data Type:

array

Description:

Filters the CarePlans to those that are part of the specified CarePlan, identified by their CarePlan.partOf reference.

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

Sample Value: CarePlan/shaO74NZR7CTOEKDLODIFSODJS4DLRWBEJ6XIO4PGOGJDCTSMCWVNSQ

Name:

performer

optional

Type:

formData

Data Type:

array

Description:

Filters CarePlans by the requested performer, identified by their CarePlan.performer reference.

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

Sample Value: Practitioner/RWBEJ6XIO4PGOGJDCTSMCWVNSQ

Name:

replaces

optional

Type:

formData

Data Type:

array

Description:

Filters CarePlans by the CarePlan it replaces, identified by their CarePlan.replaces reference.

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

Sample Value: CarePlan/shaO74NZR7CTOEKDLODIFSODJS4DLRWBEJ6XIO4PGOGJDCTSMCWVNSQ

Name:

status

optional

Type:

formData

Data Type:

array

Description:

Filters the CarePlans to those that match the specified status. The status may consists of a coding system and a code separated using a URL encoded | character i.e. %7c

The supported values are:

• active
• on-hold
• cancelled
• completed
• entered-in-error
• revoked
• draft
• unknown

Note:

• If a status system is specified only http://hl7.org/fhir/request-status can be used.
• Supports passing in a comma-separated list of values.

Sample Value: active

Name:

created

optional

Type:

formData

Data Type:

array

Description:

Filters the CarePlans to those with a created date on, 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

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

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

Name:

title

optional

Type:

formData

Data Type:

array

Description:

Filters the CarePlans to those that include a specified string within the CarePlan.title.

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

Sample Value: pain

Name:

author

optional

Type:

formData

Data Type:

array

Description:

Filters CarePlans by the designated responsible party, identified by their CarePlan.author reference.

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

Sample Value: Practitioner/AUNKCOKM758HDUSPPVNSQ

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: Orion%20Health%E2%84%A2%20R4%20HL7V2%20CDR%20CarePlans

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: Orion%20Health%E2%84%A2%20R4%20HL7V2%20CDR%20CarePlans

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:

_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:

_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=date,encounter,status,_elements:exclude=*.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:

• date to sort by CarePlan.period ascending
• -date to sort by CarePlan.period descending
• created to sort by CarePlan.created ascending
• -created to sort by CarePlan.created descending
• title to sort by CarePlan.title ascending
• -title to sort by CarePlan.title descending
• _lastUpdated to sort by CarePlan.Meta.lastUpdated ascending
• -_lastUpdatedto sort by CarePlan.Meta.lastUpdated descending

You can use any combination of the parameters

Default Value: -date

Sample Value: _sort=-date,_sort=-date,-_lastUpdated,-created

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: xml

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:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.

Sample Value: adUEctf6urd

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:

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/json

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 CarePlan resource

Sample Value: shaOLWCODILRO27UMAVBSKXWKHTVHGGQMP2FW2B3VAF33PL42Q6BBIQ

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=date,encounter,status,_elements:exclude=*.encounter

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: xml

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:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.

Sample Value: adUEctf6urd

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:

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/json

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 CarePlan resource

Sample Value: shaOLWCODILRO27UMAVBSKXWKHTVHGGQMP2FW2B3VAF33PL42Q6BBIQ

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=date,encounter,status,_elements:exclude=*.encounter

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: xml

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:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.

Sample Value: adUEctf6urd

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:

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/json

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 CarePlan resource

Sample Value: shaOLWCODILRO27UMAVBSKXWKHTVHGGQMP2FW2B3VAF33PL42Q6BBIQ

Name:

versionid

required

Type:

path

Data Type:

integer

Description:

The version of the CarePlan resource

Sample Value: 1

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=date,encounter,status,_elements:exclude=*.encounter

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: xml

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:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.

Sample Value: adUEctf6urd

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:

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/json

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.