FHIR Encounter

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:

date

optional

Type:

query

Data Type:

array

Description:

Filters the Encounters to those with a 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

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

Sample Value: gt2009-01-01T01:00:00%2B13:00

Name:

type

optional

Type:

query

Data Type:

array

Description:

Filters the encounters to ones with the specified type(s). The type 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: type=http://snomed.info/sct|183807002

Name:

class

optional

Type:

query

Data Type:

array

Description:

Filters the encounters to ones with the specified classification(s). The class 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: class=AMB,http://terminology.hl7.org/CodeSystem/v3-ActCode|IMP

Name:

status

optional

Type:

query

Data Type:

array

Description:

Filters the encounters to those having the specified status value(s). Multiple statuses can be specified as comma separated values. Possible values are

• planned
• arrived
• triaged
• in-progress
• onleave
• finished
• cancelled
• entered-in-error

• unknown

  Note:

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

Sample Value: final,registered

Name:

identifier

optional

Type:

query

Data Type:

array

Description:

Filters Encounters by the identifier associated with this encounter.

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:

reason-code

optional

Type:

query

Data Type:

array

Description:

Filters the encounters to ones with the specified reason code(s). The reason-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: reason-code=http://snomed.info/sct|34068001P

Name:

reason-reference

optional

Type:

query

Data Type:

array

Description:

Filters encounters by the reason reference. Identified by Encounter.reasonReference reference.

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

Sample Value: result-reference:Condition.code=http://snomed.info/sct|363346000

Name:

service-provider

optional

Type:

query

Data Type:

array

Description:

Filters encounters by he organization (facility) responsible for the Encounter. Identified by Encounter.serviceProvider reference.

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

Sample Value: service-provider.type=http://terminology.hl7.org/CodeSystem/organization-type|prov , http://terminology.hl7.org/CodeSystem/organization-type|dept

Name:

diagnosis

optional

Type:

query

Data Type:

array

Description:

Filters encounters by the diagnosis or procedure relevant to the encounter. Identified by Encounter.diagnosis.condition reference.

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

Sample Value: diagnosis:Condition.code=http://snomed.info/sct|363346000

Name:

participant

optional

Type:

query

Data Type:

array

Description:

Filters encounters by the persons involved in the encounter other than the patient. Identified by Encounter.participant.individual reference.

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

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

Name:

practitioner

optional

Type:

query

Data Type:

array

Description:

Filters encounters by the practitioners involved in the encounter. Identified by Encounter.participant.individual when the individual is a Practitioner reference.

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

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

Name:

participant-type

optional

Type:

query

Data Type:

array

Description:

Filters the encounters the role(s) of participant in the encounter. The participant-type 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: participant-type=http://terminology.hl7.org/CodeSystem/v3-ParticipationType|CON, http://terminology.hl7.org/CodeSystem/v3-ParticipationType|REF

Name:

special-arrangement

optional

Type:

query

Data Type:

array

Description:

Filters the encounters special arrangement(s) associated to the encounter. The class 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: special-arrangement=dog

Name:

account

optional

Type:

query

Data Type:

array

Description:

Filters encounters by the accounts that may be used for billing for the encounter. Identified by Encounter.account reference.

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

Sample Value: account.type=PBILLACCT

Name:

part-of

optional

Type:

query

Data Type:

array

Description:

Filters encounters by by Another Encounter that the Encounter is part of. Identified by Encounter.partOf reference.

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

Sample Value: part-of=Encounter/shaO74NZR7CTOEKDLODIFSODJS4DLRWBEJ6XIO4PGOGJDCTSMCWVNSQ

Name:

based-on

optional

Type:

query

Data Type:

array

Description:

Filters encounters by the ServiceRequest that initiated the Encounter. Identified by Encounter.basedOn reference.

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

Sample Value: based-on.code=http://snomed.info/sct|62013009,http://loinc.org|35542-0

Name:

location

optional

Type:

query

Data Type:

array

Description:

Filters encounters by the Location where the Encounter took place. Identified by Encounter.location reference.

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

Sample Value: location.type=AMB & location.address-city=AUCKLAND

Name:

location-period

optional

Type:

query

Data Type:

array

Description:

Filters the Encounters filter encounters by the time period during which the patient was present at the location, compare to a 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

• location-period=gt{dateTimeValue}
• location-period=ge{dateTimeValue}&location-period=le{dateTimeValue}

Sample Value: location-period=gt2012-01-01&location-period=lt2022-01-01

Name:

appointment

optional

Type:

query

Data Type:

array

Description:

Filters encounters by the appointment that scheduled the encounter. Identified by Encounter.appointment reference.

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

Sample Value: appointment.date=gt2024-01-01&appointment.date=gt2024-02-01

Name:

episode-of-care

optional

Type:

query

Data Type:

array

Description:

Filters encounters by the Episode(s) of care that this encounter should be recorded against. Identified by Encounter.episodeOfCare reference.

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

Sample Value: episode-of-care.date=gt2024-01-01 & episode-of-care.date=gt2024-02-01

Name:

length

optional

Type:

query

Data Type:

array

Description:

Filters the encounter by length of the visit. The length 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

• length={prefix}}{value}|{units system}|{unit code}
• length={prefix}}{value}|{units system}|{unit code} & {prefix}}{value}|{units system}|{unit code}
• length={ge}}{value}|{units system}|{unit code} & {le}}{value}|{units system}|{unit code}

Sample Value: length=gt30|http://unitsofmeasure.org|min & length=lt100|http://unitsofmeasure.org|min

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%5C%5Cu2122%20R4%20HL7V2%20Encounters

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%5C%5Cu2122%20R4%20HL7V2%20Encounters

Name:

-cdr-include-cancelled

optional

Type:

query

Data Type:

string

Description:

The Only supported values for the parameter are "true" or "false". Set to true to return all CDR8 encounters (including the cancelled that are not returned by default).

Note: -cdr-include-cancelled is applicable only for the Encounters CDR8 source, and ignored by other sources.

Sample Value: true

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,type,status,_elements:exclude=*.extension,*.basedOn

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 Encounter.period ascending (sorting the Encounter.period.start)
• -date to sort by Encounter.period descending (sorting the Encounter.period.start)
• _lastUpdated to sort by Encounter.Meta.lastUpdated ascending
• -_lastUpdatedto sort by Encounter.Meta.lastUpdated descending

You can use any combination of the parameters

Default Value: -date

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

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:

date

optional

Type:

formData

Data Type:

array

Description:

Filters the Encounters to those with a 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

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

Sample Value: gt2009-01-01T01:00:00%2B13:00

Name:

type

optional

Type:

formData

Data Type:

array

Description:

Filters the encounters to ones with the specified type(s). The type 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: type=http://snomed.info/sct|183807002

Name:

class

optional

Type:

formData

Data Type:

array

Description:

Filters the encounters to ones with the specified classification(s). The class 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: class=AMB,http://terminology.hl7.org/CodeSystem/v3-ActCode|IMP

Name:

status

optional

Type:

formData

Data Type:

array

Description:

Filters the encounters to those having the specified status value(s). Multiple statuses can be specified as comma separated values. Possible values are

• planned
• arrived
• triaged
• in-progress
• onleave
• finished
• cancelled
• entered-in-error

• unknown

  Note:

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

Sample Value: final,registered

Name:

identifier

optional

Type:

formData

Data Type:

array

Description:

Filters Encounters by the identifier associated with this encounter.

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:

reason-code

optional

Type:

formData

Data Type:

array

Description:

Filters the encounters to ones with the specified reason code(s). The reason-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: reason-code=http://snomed.info/sct|34068001P

Name:

reason-reference

optional

Type:

formData

Data Type:

array

Description:

Filters encounters by the reason reference. Identified by Encounter.reasonReference reference.

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

Sample Value: result-reference:Condition.code=http://snomed.info/sct|363346000

Name:

service-provider

optional

Type:

formData

Data Type:

array

Description:

Filters encounters by he organization (facility) responsible for the Encounter. Identified by Encounter.serviceProvider reference.

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

Sample Value: service-provider.type=http://terminology.hl7.org/CodeSystem/organization-type|prov , http://terminology.hl7.org/CodeSystem/organization-type|dept

Name:

diagnosis

optional

Type:

formData

Data Type:

array

Description:

Filters encounters by the diagnosis or procedure relevant to the encounter. Identified by Encounter.diagnosis.condition reference.

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

Sample Value: diagnosis:Condition.code=http://snomed.info/sct|363346000

Name:

participant

optional

Type:

formData

Data Type:

array

Description:

Filters encounters by the persons involved in the encounter other than the patient. Identified by Encounter.participant.individual reference.

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

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

Name:

practitioner

optional

Type:

formData

Data Type:

array

Description:

Filters encounters by the practitioners involved in the encounter. Identified by Encounter.participant.individual when the individual is a Practitioner reference.

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

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

Name:

participant-type

optional

Type:

formData

Data Type:

array

Description:

Filters the encounters the role(s) of participant in the encounter. The participant-type 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: participant-type=http://terminology.hl7.org/CodeSystem/v3-ParticipationType|CON, http://terminology.hl7.org/CodeSystem/v3-ParticipationType|REF

Name:

special-arrangement

optional

Type:

formData

Data Type:

array

Description:

Filters the encounters special arrangement(s) associated to the encounter. The class 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: special-arrangement=dog

Name:

account

optional

Type:

formData

Data Type:

array

Description:

Filters encounters by the accounts that may be used for billing for the encounter. Identified by Encounter.account reference.

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

Sample Value: account.type=PBILLACCT

Name:

part-of

optional

Type:

formData

Data Type:

array

Description:

Filters encounters by by Another Encounter that the Encounter is part of. Identified by Encounter.partOf reference.

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

Sample Value: part-of=Encounter/shaO74NZR7CTOEKDLODIFSODJS4DLRWBEJ6XIO4PGOGJDCTSMCWVNSQ

Name:

based-on

optional

Type:

formData

Data Type:

array

Description:

Filters encounters by the ServiceRequest that initiated the Encounter. Identified by Encounter.basedOn reference.

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

Sample Value: based-on.code=http://snomed.info/sct|62013009,http://loinc.org|35542-0

Name:

location

optional

Type:

formData

Data Type:

array

Description:

Filters encounters by the Location where the Encounter took place. Identified by Encounter.location reference.

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

Sample Value: location.type=AMB & location.address-city=AUCKLAND

Name:

location-period

optional

Type:

formData

Data Type:

array

Description:

Filters the Encounters filter encounters by the time period during which the patient was present at the location, compare to a 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

• location-period=gt{dateTimeValue}
• location-period=ge{dateTimeValue}&location-period=le{dateTimeValue}

Sample Value: location-period=gt2012-01-01&location-period=lt2022-01-01

Name:

appointment

optional

Type:

formData

Data Type:

array

Description:

Filters encounters by the appointment that scheduled the encounter. Identified by Encounter.appointment reference.

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

Sample Value: appointment.date=gt2024-01-01&appointment.date=gt2024-02-01

Name:

episode-of-care

optional

Type:

formData

Data Type:

array

Description:

Filters encounters by the Episode(s) of care that this encounter should be recorded against. Identified by Encounter.episodeOfCare reference.

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

Sample Value: episode-of-care.date=gt2024-01-01 & episode-of-care.date=gt2024-02-01

Name:

length

optional

Type:

formData

Data Type:

array

Description:

Filters the encounter by length of the visit. The length 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

• length={prefix}}{value}|{units system}|{unit code}
• length={prefix}}{value}|{units system}|{unit code} & {prefix}}{value}|{units system}|{unit code}
• length={ge}}{value}|{units system}|{unit code} & {le}}{value}|{units system}|{unit code}

Sample Value: length=gt30|http://unitsofmeasure.org|min & length=lt100|http://unitsofmeasure.org|min

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%5C%5Cu2122%20R4%20HL7V2%20Encounters

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%5C%5Cu2122%20R4%20HL7V2%20Encounters

Name:

-cdr-include-cancelled

optional

Type:

formData

Data Type:

string

Description:

The Only supported values for the parameter are "true" or "false". Set to true to return all CDR8 encounters (including the cancelled that are not returned by default).

Note: -cdr-include-cancelled is applicable only for the Encounters CDR8 source, and ignored by other sources.

Sample Value: true

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,type,status,_elements:exclude=*.extension,*.basedOn

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 Encounter.period ascending (sorting the Encounter.period.start)
• -date to sort by Encounter.period descending (sorting the Encounter.period.start)
• _lastUpdated to sort by Encounter.Meta.lastUpdated ascending
• -_lastUpdatedto sort by Encounter.Meta.lastUpdated descending

You can use any combination of the parameters

Default Value: -date

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

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

Sample Value: shaO74NZR7CTOEKDLODIFSODJS4DLRWBEJ6XIO4PGOGJDCTSMCWVNSQ

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,type,status,_elements:exclude=*.extension,*.basedOn

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

Sample Value: shaO74NZR7CTOEKDLODIFSODJS4DLRWBEJ6XIO4PGOGJDCTSMCWVNSQ

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,status,class,_elements:exclude=*.extension,*.basedOn

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

Sample Value: shaO74NZR7CTOEKDLODIFSODJS4DLRWBEJ6XIO4PGOGJDCTSMCWVNSQ

Name:

versionid

required

Type:

path

Data Type:

string

Description:

The version of the Encounter 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,status,class,_elements:exclude=*.extension,*.basedOn

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.