FHIR MedicationDispense

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|AAAA-0124-8

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

Name:

status

optional

Type:

query

Data Type:

array

Description:

Filters the medications dispensed 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:

• preparation
• in-progress
• cancelled
• on-hold
• completed
• entered-in-error
• stopped
• declined
• unknown

Note:

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

Sample Value: completed

Name:

code

optional

Type:

query

Data Type:

array

Description:

Filters the dispenses of this medicine to ones that matches the specified code or codes. 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|261000

Name:

context

optional

Type:

query

Data Type:

array

Description:

Filters MedicationDispense by the dispenses for a specific context for this MedicationDispense, identified by their MedicationDispense.context reference.

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

Sample Value: context:Encounter.identifier=SYS_A|visti123

Name:

destination

optional

Type:

query

Data Type:

array

Description:

Filters MedicationDispense by dispenses that should be sent to a specific destination, identified by their MedicationDispense.destination reference.

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

Sample Value: destination:Location.address-city=AUCKLAND

Name:

identifier

optional

Type:

query

Data Type:

array

Description:

Filters MedicationDispense by the identifier associated with this medication dispense.

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:

medication

optional

Type:

query

Data Type:

array

Description:

Filters MedicationDispense by dispenses of this medicine resource, identified by their MedicationDispense.medication reference.

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

Sample Value: medication:Medication.code=http://snomed.info/sct|261000

Name:

performer

optional

Type:

query

Data Type:

array

Description:

Filters MedicationDispense by the dispenses performed by a specific individual, identified by their MedicationDispense.performer.actor 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: performer:Practitioner.family=Smith&performer:Practitioner.given=Bob,Robert

Name:

prescription

optional

Type:

query

Data Type:

array

Description:

Filters MedicationDispense by the identity of a prescription to list dispenses from, identified by their MedicationDispense.authorizingPrescription reference.

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

Sample Value: prescription:MedicationRequest.identifier=SYS_A|123

Name:

receiver

optional

Type:

query

Data Type:

array

Description:

Filters MedicationDispense by the identity of a receiver to list dispenses for, identified by their MedicationDispense.receiver reference.

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

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

Name:

responsibleparty

optional

Type:

query

Data Type:

array

Description:

Filters MedicationDispense by the dispenses with the specified responsible party, identified by their MedicationDispense.substitution.responsibleParty reference.

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

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

Name:

type

optional

Type:

query

Data Type:

array

Description:

Filters the dispenses of this medicine to ones that matches the specified type or types. 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: http://terminology.hl7.org/CodeSystem/v3-ActCode|DF

Name:

whenhandedover

optional

Type:

query

Data Type:

array

Description:

Filters the MedicationDispense to those with a dispenses handed over on this 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

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

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

Name:

whenprepared

optional

Type:

query

Data Type:

array

Description:

Filters the MedicationDispense to those with a dispenses prepared on this 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

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

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

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

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:

• whenhandedover to sort by MedicationDispense.whenHandedOver ascending
• -whenhandedover to sort by MedicationDispense.whenHandedOver descending
• whenprepared to sort by MedicationDispense.whenPrepared ascending
• -whenprepared to sort by MedicationDispense.whenPrepared descending
• _lastUpdated to sort by MedicationDispense.Meta.lastUpdated ascending
• -_lastUpdatedto sort by MedicationDispense.Meta.lastUpdated descending

You can use any combination of the parameters

Default Value: -whenhandedover

Sample Value: _sort=-whenhandedover,_sort=-whenhandedover, -_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|AAAA-0124-8

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:

status

optional

Type:

formData

Data Type:

array

Description:

Filters the medications dispensed 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:

• preparation
• in-progress
• cancelled
• on-hold
• completed
• entered-in-error
• stopped
• declined
• unknown

Note:

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

Sample Value: completed

Name:

code

optional

Type:

formData

Data Type:

array

Description:

Filters the dispenses of this medicine to ones that matches the specified code or codes. 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|261000

Name:

context

optional

Type:

formData

Data Type:

array

Description:

Filters MedicationDispense by the returns dispenses for a specific context for this MedicationDispense, identified by their MedicationDispense.context reference.

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

Sample Value: context:Encounter.identifier=SYS_A|visti123

Name:

destination

optional

Type:

formData

Data Type:

array

Description:

Filters MedicationDispense by dispenses that should be sent to a specific destination, identified by their MedicationDispense.destination reference.

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

Sample Value: destination:Location.address-city=AUCKLAND

Name:

identifier

optional

Type:

formData

Data Type:

array

Description:

Filters MedicationDispense by the identifier associated with this medication dispense.

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:

medication

optional

Type:

formData

Data Type:

array

Description:

Filters MedicationDispense by dispenses of this medicine resource, identified by their MedicationDispense.medication reference.

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

Sample Value: medication:Medication.code=http://snomed.info/sct|261000

Name:

performer

optional

Type:

formData

Data Type:

array

Description:

Filters MedicationDispense by the dispenses performed by a specific individual, identified by their MedicationDispense.performer.actor 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: performer:Practitioner.family=Smith&performer:Practitioner.given=Bob,Robert

Name:

prescription

optional

Type:

formData

Data Type:

array

Description:

Filters MedicationDispense by the identity of a prescription to list dispenses from, identified by their MedicationDispense.authorizingPrescription reference.

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

Sample Value: prescription:MedicationRequest.identifier=SYS_A|123

Name:

receiver

optional

Type:

formData

Data Type:

array

Description:

Filters MedicationDispense by the identity of a receiver to list dispenses for, identified by their MedicationDispense.receiver reference.

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

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

Name:

responsibleparty

optional

Type:

formData

Data Type:

array

Description:

Filters MedicationDispense by the dispenses with the specified responsible party, identified by their MedicationDispense.substitution.responsibleParty reference.

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

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

Name:

type

optional

Type:

formData

Data Type:

array

Description:

Filters the dispenses of this medicine to ones that matches the specified type or types. 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: http://terminology.hl7.org/CodeSystem/v3-ActCode|DF

Name:

whenhandedover

optional

Type:

formData

Data Type:

array

Description:

Filters the MedicationDispense to those with a dispenses handed over on this 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

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

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

Name:

whenprepared

optional

Type:

formData

Data Type:

array

Description:

Filters the MedicationDispense to those with a dispenses prepared on this 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

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

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

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

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:

• whenhandedover to sort by MedicationDispense.whenHandedOver ascending
• -whenhandedover to sort by MedicationDispense.whenHandedOver descending
• whenprepared to sort by MedicationDispense.whenPrepared ascending
• -whenprepared to sort by MedicationDispense.whenPrepared descending
• _lastUpdated to sort by MedicationDispense.Meta.lastUpdated ascending
• -_lastUpdatedto sort by MedicationDispense.Meta.lastUpdated descending

You can use any combination of the parameters

Default Value: -whenhandedover

Sample Value: _sort=-whenhandedover,_sort=-whenhandedover, -_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 MedicationDispense resource

Sample Value: shaRX3UJ74E2IMZATDCXTQTUJCN2MESWV3S3AFKKWLOREDT2YWE2HJA

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

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:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.

Sample Value: adUEctf6urd

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

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:

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

Sample Value: shaRX3UJ74E2IMZATDCXTQTUJCN2MESWV3S3AFKKWLOREDT2YWE2HJA

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

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:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.

Sample Value: adUEctf6urd

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

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:

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

Sample Value: shaRX3UJ74E2IMZATDCXTQTUJCN2MESWV3S3AFKKWLOREDT2YWE2HJA

Name:

versionid

required

Type:

path

Data Type:

string

Description:

The version of the MedicationDispense resource

Sample Value: 1

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

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:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.

Sample Value: adUEctf6urd

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

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:

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.