FHIR Appointment

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 a combination of those parameters.

• 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: SYS_A|75849-3478

Name:

patient

required

Type:

query

Data Type:

string

Description:

The patient resource id.

Note:

• You must either define the patient.identifier or patient, not a combination of those parameters.

• In addition to having the required patient.identifieror 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:

actor

optional

Type:

query

Data Type:

array

Description:

Filters appointments based on the individuals participating, identified by their appointment.participant.actor reference.

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

Sample Value: actor:Practitioner.name=Julie Miller

Name:

appointment-type

optional

Type:

query

Data Type:

array

Description:

Filters appointments that match the specified type of appointment or patient that has been booked in the slot. For each specified appointment-type, system and code are separated using a URL encoded | character i.e. %7c. It is matched to the Appointment.appointmentType.

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

Sample Value: http://terminology.hl7.org/CodeSystem/v2-0276|EMERGENCY

Name:

based-on

optional

Type:

query

Data Type:

array

Description:

Filters appointments by the referenced ServiceRequest to which the appointment is allocated for assessment, identified by the Appointment.basedOn.

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

Sample Value: based-on.priority=urgent

Name:

date

optional

Type:

query

Data Type:

array

Description:

Filters the appointments to those with a start 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: gt2013-01-01T01:00:00%2B13:00

Name:

identifier

optional

Type:

query

Data Type:

array

Description:

Filters appointments based on the identifier associated with this appointment.

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

Name:

location

optional

Type:

query

Data Type:

array

Description:

Filters appointments based on the reference location(s), identified by the Appointment.participant.actor.where(Location) reference.

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

Sample Value: location.name=Serenity Wellness

Name:

part-status

optional

Type:

query

Data Type:

array

Description:

Filters appointments based on the participation status of participants on the appointment. Multiple statuses can be specified as comma-separated values. Possible values are:

• accepted
• declined
• tentative

• needs-action

  Note:

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

Sample Value: accepted

Name:

practitioner

optional

Type:

query

Data Type:

array

Description:

Filters appointments based on the practitioners participating in the appointment, identified by the Appointment.participant.actor.where(Practitioner) reference.

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

Sample Value: practitioner.family=Davis & practitioner.active=true

Name:

reason-code

optional

Type:

query

Data Type:

array

Description:

Filters appointments based on the coded reason for scheduling this appointment. For each specified reason-code, system and code are separated using a URL encoded | character i.e. %7c. The combo code is matched to theAppointment.reasonCode.

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

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

Name:

reason-reference

optional

Type:

query

Data Type:

array

Description:

Filters appointments based on the reasons referenced for the appointment, identified by the Appointment.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: reason-reference:Observation.status=registered

Name:

service-category

optional

Type:

query

Data Type:

array

Description:

Filters appointments based on the categorisation of the service that is to be performed during this appointment. For each specified service-category, system and code are separated using a URL encoded | character i.e. %7c. The service-category is matched to theAppointment.serviceCategory.

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

Sample Value: http://terminology.hl7.org/CodeSystem/service-category|22

Name:

service-type

optional

Type:

query

Data Type:

array

Description:

Filters appointments based on the specific type of service to be performed during this appointment. For each specified service-type, system and code are 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/service-type|79

Name:

slot

optional

Type:

query

Data Type:

array

Description:

Filters appointments based on the slots that the appointment occupies, identified by the Appointment.slot reference.

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

Sample Value: slot.identifier=SYS_A|22DC

Name:

specialty

optional

Type:

query

Data Type:

array

Description:

Filters appointments based on the specialty of the practitioner required to perform the requested service. For each specified specialty, system and code are 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|408467006

Name:

status

optional

Type:

query

Data Type:

array

Description:

Filters appointments that match the specified status. Multiple statuses can be specified as comma separated values.

The supported values are:

• proposed
• pending
• booked
• arrived
• fulfilled
• cancelled
• noshow
• entered-in-error
• checked-in

• waitlist

  Note:

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

Sample Value: arrived

Name:

supporting-info

optional

Type:

query

Data Type:

array

Description:

Filters appointments based on additional information that supports the appointment, identified by Appointment.supportingInformation references.

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

Sample Value: supporting-info:Apppointment.type=FOLLOWUP,ROUTINE & supporting-info:Appointment.specialty=http://snomed.info/sct|408480009

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:

-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 parameters 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%20Appointments

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%20Appointments

Name:

_elements

optional

Type:

query

Data Type:

string

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

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:

-cursor

optional

Type:

query

Data Type:

string

Description:

This is a server internal parameter to navigate different pages, indicating the server a cursor till where result matches were already returned.

This parameter is returned by the server as part of the next link of a paginated query.

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

Name:

_sort

optional

Type:

query

Data Type:

string

Description:

Request which order results should be returned in.

Supported _sort parameters are:

• date to sort by Appointment.start ascending.
• -date to sort by Appointment.start descending.
• _lastUpdated to sort by Appointment.meta.lastUpdated ascending.
• -_lastUpdated to sort by Appointment.meta.lastUpdated descending.

You can use any combination of the parameters.

Default Value: -date

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

Name:

_lastUpdated

optional

Type:

query

Data Type:

array

Description:

Allows the user to filter appointments by the lastUpdated date. The date value can be a single date, as well as lower and/or upper bound.

The supported operations are: =gt, =ge, =lt, =ne, =le, =eq. For more information about using these search operators, refer to the date section on the FHIR Search page.

The {dateTimeValue} value should be in the following format: 2013-01-01T23:00:00-05:00. However, the time portion can be excluded. If a time portion is provided, the time zone must be provided as well.

It is highly recommended to provide the time zone portion in any query. Ensure that special characters such as '+' are encoded so that it can be interpreted correctly. For example: "2014-01-01T00:00:00+13:00" should be encoded like this: "2014-01-01T00:00:00%2B13:00".

If a date query comes in without a time zone, the date will be interpreted according to the server's time zone.

Including this query parameter includes all Appointments that match the specified Appointment.Meta.lastUpdated.

Sample Value: _lastUpdated=gt2012-01-01&_lastUpdated=lt2022-01-01

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.

Sample Value: X-Request-ID: adUEctf6urd

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml.

Default Value: application/xml

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:

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 a combination of those parameters.

• 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: SYS_A|75849-3478

Name:

patient

required

Type:

formData

Data Type:

string

Description:

The patient resource id.

Note:

• You must either define the patient.identifier or patient, not a combination of those parameters.

• In addition to having the required patient.identifieror 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:

actor

optional

Type:

formData

Data Type:

array

Description:

Filters appointments based on the individuals participating, identified by their appointment.participant.actor reference.

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

Sample Value: actor:Practitioner.name=Julie Miller

Name:

appointment-type

optional

Type:

formData

Data Type:

array

Description:

Filters appointments that match the specified type of appointment or patient that has been booked in the slot. For each specified appointment-type, system and code are separated using a URL encoded | character i.e. %7c. It is matched to the Appointment.appointmentType.

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

Sample Value: http://terminology.hl7.org/CodeSystem/v2-0276|EMERGENCY

Name:

based-on

optional

Type:

formData

Data Type:

array

Description:

Filters appointments by the referenced ServiceRequest to which the appointment is allocated for assessment, identified by the Appointment.basedOn.

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

Sample Value: based-on.priority=urgent

Name:

date

optional

Type:

formData

Data Type:

array

Description:

Filters the appointments to those with a start 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: gt2013-01-01T01:00:00%2B13:00

Name:

identifier

optional

Type:

formData

Data Type:

array

Description:

Filters appointments based on the identifier associated with this appointment.

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

Name:

location

optional

Type:

formData

Data Type:

array

Description:

Filters appointments based on the reference location(s), identified by the Appointment.participant.actor.where(Location) reference.

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

Sample Value: location.name=Serenity Wellness

Name:

part-status

optional

Type:

formData

Data Type:

array

Description:

Filters appointments based on the participation status of participants on the appointment. Multiple statuses can be specified as comma-separated values. Possible values are:

• accepted
• declined
• tentative

• needs-action

  Note:

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

Sample Value: accepted

Name:

practitioner

optional

Type:

formData

Data Type:

array

Description:

Filters appointments based on the practitioners participating in the appointment, identified by the Appointment.participant.actor.where(Practitioner) reference.

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

Sample Value: practitioner.family=Davis & practitioner.active=true

Name:

reason-code

optional

Type:

formData

Data Type:

array

Description:

Filters appointments based on the coded reason for scheduling this appointment. For each specified reason-code, system and code are separated using a URL encoded | character i.e. %7c. The combo code is matched to theAppointment.reasonCode.

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

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

Name:

reason-reference

optional

Type:

formData

Data Type:

array

Description:

Filters appointments based on the reasons referenced for the appointment, identified by the Appointment.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: reason-reference:Observation.status=registered

Name:

service-category

optional

Type:

formData

Data Type:

array

Description:

Filters appointments based on the categorisation of the service that is to be performed during this appointment. For each specified service-category, system and code are separated using a URL encoded | character i.e. %7c. The service-category is matched to theAppointment.serviceCategory.

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

Sample Value: http://terminology.hl7.org/CodeSystem/service-category|22

Name:

service-type

optional

Type:

formData

Data Type:

array

Description:

Filters appointments based on the specific type of service to be performed during this appointment. For each specified service-type, system and code are 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/service-type|79

Name:

slot

optional

Type:

formData

Data Type:

array

Description:

Filters appointments based on the slots that the appointment occupies, identified by the Appointment.slot reference.

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

Sample Value: slot.identifier=SYS_A|22DC

Name:

specialty

optional

Type:

formData

Data Type:

array

Description:

Filters appointments based on the specialty of the practitioner required to perform the requested service. For each specified specialty, system and code are 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|408467006

Name:

status

optional

Type:

formData

Data Type:

array

Description:

Filters appointments that match the specified status. Multiple statuses can be specified as comma separated values.

The supported values are:

• proposed
• pending
• booked
• arrived
• fulfilled
• cancelled
• noshow
• entered-in-error
• checked-in

• waitlist

  Note:

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

Sample Value: arrived

Name:

supporting-info

optional

Type:

formData

Data Type:

array

Description:

Filters appointments based on additional information that supports the appointment, identified by Appointment.supportingInformation references.

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

Sample Value: supporting-info:Apppointment.type=FOLLOWUP,ROUTINE & supporting-info:Appointment.specialty=http://snomed.info/sct|408480009

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:

-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 parameters 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%20Appointments

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%20Appointments

Name:

_elements

optional

Type:

formData

Data Type:

string

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

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:

-cursor

optional

Type:

formData

Data Type:

string

Description:

This is a server internal parameter to navigate different pages, indicating the server a cursor till where result matches were already returned.

This parameter is returned by the server as part of the next link of a paginated query.

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

Name:

_sort

optional

Type:

formData

Data Type:

string

Description:

Request which order results should be returned in.

Supported _sort parameters are:

• date to sort by Appointment.start ascending.
• -date to sort by Appointment.start descending.
• _lastUpdated to sort by Appointment.meta.lastUpdated ascending.
• -_lastUpdated to sort by Appointment.meta.lastUpdated descending.

You can use any combination of the parameters.

Default Value: -date

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

Name:

_lastUpdated

optional

Type:

formData

Data Type:

array

Description:

Allows the user to filter appointments by the lastUpdated date. The date value can be a single date, as well as lower and/or upper bound.

The supported operations are: =gt, =ge, =lt, =ne, =le, =eq. For more information about using these search operators, refer to the date section on the FHIR Search page.

The {dateTimeValue} value should be in the following format: 2013-01-01T23:00:00-05:00. However, the time portion can be excluded. If a time portion is provided, the time zone must be provided as well.

It is highly recommended to provide the time zone portion in any query. Ensure that special characters such as '+' are encoded so that it can be interpreted correctly. For example: "2014-01-01T00:00:00+13:00" should be encoded like this: "2014-01-01T00:00:00%2B13:00".

If a date query comes in without a time zone, the date will be interpreted according to the server's time zone.

Including this query parameter includes all Appointments that match the specified Appointment.meta.lastUpdated.

Sample Value: _lastUpdated=gt2012-01-01&_lastUpdated=lt2022-01-01

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.

Sample Value: X-Request-ID: adUEctf6urd

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml.

Default Value: application/xml

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:

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 Appointment resource.

Sample Value: shaHMEZO7XB3F6CZB6Z6TX2TJXB5JPO3X6IKLZO2LTFOSR3Z6FZK45A

Name:

_elements

optional

Type:

query

Data Type:

string

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

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:

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

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml.

Default Value: application/xml

Sample Value: application/json

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.

Sample Value: X-Request-ID: 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:

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

Sample Value: shaHMEZO7XB3F6CZB6Z6TX2TJXB5JPO3X6IKLZO2LTFOSR3Z6FZK45A

Name:

_elements

optional

Type:

query

Data Type:

string

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

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:

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

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml.

Default Value: application/xml

Sample Value: application/json

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.

Sample Value: X-Request-ID: 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:

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

Sample Value: shaHMEZO7XB3F6CZB6Z6TX2TJXB5JPO3X6IKLZO2LTFOSR3Z6FZK45A

Name:

versionid

required

Type:

path

Data Type:

integer

Description:

The version of the Appointment resource

Sample Value: 1

Name:

_elements

optional

Type:

query

Data Type:

string

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

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:

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

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml.

Default Value: application/xml

Sample Value: application/json

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.

Sample Value: X-Request-ID: 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:

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.