FHIR DiagnosticReport

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. The 'subject.identifier' variant of this parameter is also supported.

Note:

• You must either define the patient.identifier or patient or subject.identifier or subject, not a combination of those parameters.
• In addition to having the required patient.identifier, patient, subject.identifier or subject, you can defined chained patient or subject 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. The 'subject' variant of this parameter is also supported.

Note:

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

• In addition to having the required patient.identifier, patient, subject.identifier or subject, you can defined chained patient or subject 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:

subject.identifier

required

Type:

query

Data Type:

string

Description:

The subject identifier consists of subject identifier namespace, also known as the system, and identifier, separated using a URL encoded | character i.e. %7c. The 'patient.identifier' variant of this parameter is also supported.

Note:

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

Sample format of the query is

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

Sample Value: ORION|AAA-00315-7

Name:

subject

required

Type:

query

Data Type:

string

Description:

The subject resource id. The 'patient' variant of this parameter is also supported.

Note:

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

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

  Sample format of the query is

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

Sample Value: IFAUCQJNGAYTENBNHBAE6USJJ5HA

Name:

code

optional

Type:

query

Data Type:

array

Description:

Filters the diagnostic reports to ones with a report type 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://www.ama-assn.org/go/cpt|85018

Name:

category

optional

Type:

query

Data Type:

array

Description:

Filters the diagnostic reports to ones with a department or diagnostic service that matches the specified category or categories. The category value consists of a coding system and a code separated using a URL encoded | character i.e. %7c

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

Sample Value: urn:oid:2.16.840.1.113883.12.74|IMM

Name:

date

optional

Type:

query

Data Type:

array

Description:

Filters the diagnostic reports to those with an effectiveDateTime or effectivePeriod 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: gt2012-01-01

Name:

status

optional

Type:

query

Data Type:

array

Description:

Filters the diagnostic reports by the report 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:

• registered
• partial
• preliminary
• final
• amended
• appended
• corrected
• cancelled
• entered-in-error
• unknown

Note:

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

Name:

conclusion

optional

Type:

query

Data Type:

array

Description:

Filters the diagnostic reports by the clinical conclusion of the DiagnosticReport test results. The conclusion 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|428763004

Name:

issued

optional

Type:

query

Data Type:

array

Description:

Filters the diagnostic reports to the issued date, 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

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

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

Name:

identifier

optional

Type:

query

Data Type:

array

Description:

Filters Diagnostic Reports by the identifier associated with this report.

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:

media

optional

Type:

query

Data Type:

array

Description:

Filters Diagnostic Reports by the image source, identified by their DiagnosticReport.media.link reference.

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

Sample Value: media.created=gt2012-01-01&media.operator:Practitioner.identifier=SYS_A|123

Name:

based-on

optional

Type:

query

Data Type:

array

Description:

Filters Diagnostic Reports by the reference to the service request, identified by their DiagnosticReport.baseOn 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:ServiceRequest.code=SYS_A|code1,SYS_B|code2

Name:

specimen

optional

Type:

query

Data Type:

array

Description:

Filters Diagnostic Reports by the specimen, identified by their DiagnosticReport.specimen reference.

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

Sample Value: specimen.type=http://snomed.info/sct|122555007

Name:

performer

optional

Type:

query

Data Type:

array

Description:

Filters Diagnostic Reports by the performer that is responsible for the report, identified by their DiagnosticReport.performer reference.

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

Sample Value: performer:Organization.name=Auckland%20Hospital

Name:

result

optional

Type:

query

Data Type:

array

Description:

Filters Diagnostic Reports by the result, identified by their DiagnosticReport.result reference.

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

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

Name:

results-interpreter

optional

Type:

query

Data Type:

array

Description:

Filters Diagnostic Reports by who was the source of the report, identified by their DiagnosticReport.resultsInterpreter reference.

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

Sample Value: results-interpreter:Organization.name=Auckland%20Hospital

Name:

encounter

optional

Type:

query

Data Type:

array

Description:

Filters Diagnostic Reports by the referenced encounter, identified by their DiagnosticReport.encounter reference.

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

Sample Value: encounter.identifier=SYS_A|visti123

Name:

-include-sources

optional

Type:

query

Data Type:

array

Description:

The -include-sources parameter defines which sources should be queried for the results.

Note: Either -include-sources or -exclude-sources parameter can be specified, not both. If -include-sources is specified, ONLY the specified sources will be searched. Note that the sources specified should be enabled.

Sample Value: Orion%20Health%E2%84%A2%20R4%20HL7V2%20CDR%20DiagnosticReports

Name:

-exclude-sources

optional

Type:

query

Data Type:

array

Description:

The -exclude-sources parameter defines which sources should NOT be queried for the results.

Note: Either -include-sources or -exclude-sources parameter can be specified, not both. If -exclude-sources is specified, the specified sources will NOT be searched. Note that the sources specified should be enabled.

Sample Value: Orion%20Health%E2%84%A2%20R4%20HL7V2%20CDR%20DiagnosticReports

Name:

_summary

optional

Type:

query

Data Type:

string

Description:

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

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

Sample Value: true

Name:

_lastUpdated

optional

Type:

query

Data Type:

array

Description:

Filters based on when the resource version was last changed, before, or after a specific date, date-time, or date range. The supported prefixes are gt, ge, lt, le and eq. If no prefix is used, exact date or date-time matching is implied. Dates must be formatted according to ISO 8601 either as a date only (e.g. 1997-07-16) or as a date-time including the timezone (e.g. 1997-07-16T19:20:30+13:00). Ensure that special characters such as + are URL encoded i.e. %2B.

The format of the query is

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

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

Name:

_elements

optional

Type:

query

Data Type:

array

Description:

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

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

Name:

-cursor

optional

Type:

query

Data Type:

string

Description:

A server internal parameter to navigate different pages.

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

Name:

_count

optional

Type:

query

Data Type:

integer

Description:

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

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

Sample Value: 30

Name:

_sort

optional

Type:

query

Data Type:

array

Description:

Request which order results should be returned in.

Supported _sort parameters are:

• date to sort by DiagnosticReport.effective ascending
• -date to sort by DiagnosticReport.effective descending
• issued to sort by DiagnosticReport.issued ascending
• -issued to sort by DiagnosticReport.issued descending
• _lastUpdated to sort by DiagnosticReport.Meta.lastUpdated ascending
• -_lastUpdatedto sort by DiagnosticReport.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. The subject.identifier variant of this parameter is also supported.

Note: You must either define the patient.identifier or patient, not both.

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.

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

Sample Value: IFAUCQJNGAYTENBNHBAE6USJJ5HA

Name:

code

optional

Type:

formData

Data Type:

array

Description:

Filters the diagnostic reports to ones with a report type 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://www.ama-assn.org/go/cpt|85018

Name:

category

optional

Type:

formData

Data Type:

array

Description:

Filters the diagnostic reports to ones with a department or diagnostic service that matches the specified category or categories. The category value consists of a coding system and a code separated using a URL encoded | character i.e. %7c

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

Sample Value: urn:oid:2.16.840.1.113883.12.74|IMM

Name:

date

optional

Type:

formData

Data Type:

array

Description:

Filters the diagnostic reports to those with an effectiveDateTime or effectivePeriod 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: ge2012-01-01T01:00:00+13:00

Name:

status

optional

Type:

formData

Data Type:

array

Description:

Filters the diagnostic reports by by the report status. The conclusion may consists of a coding system and a code separated using a URL encoded | character i.e. %7c

The supported values are:

• registered
• partial
• preliminary
• final
• amended
• appended
• corrected
• cancelled
• entered-in-error
• unknown

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

Name:

conclusion

optional

Type:

formData

Data Type:

array

Description:

Filters the diagnostic reports by the clinical conclusion of the DiagnosticReport test results. The conclusion 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|428763004

Name:

issued

optional

Type:

formData

Data Type:

array

Description:

Filters the diagnostic reports to the issued date, 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

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

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

Name:

identifier

optional

Type:

formData

Data Type:

array

Description:

Filters Diagnostic Reports by the identifier associated with this report.

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:

media

optional

Type:

formData

Data Type:

array

Description:

Filters Diagnostic Reports by the image source, identified by their DiagnosticReport.media.link reference.

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

Sample Value: media.created=gt2012-01-01&media.operator:Practitioner.identifier=SYS_A|123

Name:

based-on

optional

Type:

formData

Data Type:

array

Description:

Filters Diagnostic Reports by the reference to the service request, identified by their DiagnosticReport.baseOn 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:ServiceRequest.code=SYS_A|code1,SYS_B|code2

Name:

specimen

optional

Type:

formData

Data Type:

array

Description:

Filters Diagnostic Reports by the specimen, identified by their DiagnosticReport.specimen reference.

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

Sample Value: specimen.type=http://snomed.info/sct|122555007

Name:

performer

optional

Type:

formData

Data Type:

array

Description:

Filters Diagnostic Reports by the performer that is responsible for the report, identified by their DiagnosticReport.performer reference.

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

Sample Value: performer:Organization.name=Auckland%20Hospital

Name:

result

optional

Type:

formData

Data Type:

array

Description:

Filters Diagnostic Reports by the result, identified by their DiagnosticReport.result reference.

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

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

Name:

results-interpreter

optional

Type:

formData

Data Type:

array

Description:

Filters Diagnostic Reports by who was the source of the report, identified by their DiagnosticReport.resultsInterpreter reference.

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

Sample Value: results-interpreter:Organization.name=Auckland%20Hospital

Name:

encounter

optional

Type:

formData

Data Type:

array

Description:

Filters Diagnostic Reports by the referenced encounter, identified by their DiagnosticReport.encounter reference.

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

Sample Value: encounter.identifier=SYS_A|visti123

Name:

-include-sources

optional

Type:

formData

Data Type:

array

Description:

The -include-sources parameter defines which sources should be queried for the results.

Note: Either -include-sources or -exclude-sources parameter can be specified, not both. If -include-sources is specified, ONLY the specified sources will be searched. Note that the sources specified should be enabled.

Sample Value: Orion%20Health%E2%84%A2%20R4%20HL7V2%20CDR%20DiagnosticReports

Name:

-exclude-sources

optional

Type:

formData

Data Type:

array

Description:

The -exclude-sources parameter defines which sources should NOT be queried for the results.

Note: Either -include-sources or -exclude-sources parameter can be specified, not both. If -exclude-sources is specified, the specified sources will NOT be searched. Note that the sources specified should be enabled.

Sample Value: Orion%20Health%E2%84%A2%20R4%20HL7V2%20CDR%20DiagnosticReports

Name:

_summary

optional

Type:

formData

Data Type:

string

Description:

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

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

Sample Value: true

Name:

_lastUpdated

optional

Type:

formData

Data Type:

array

Description:

Filters based on when the resource version was last changed, before, or after a specific date, date-time, or date range. The supported prefixes are gt, ge, lt, le and eq. If no prefix is used, exact date or date-time matching is implied. Dates must be formatted according to ISO 8601 either as a date only (e.g. 1997-07-16) or as a date-time including the timezone (e.g. 1997-07-16T19:20:30+13:00). Ensure that special characters such as + are URL encoded i.e. %2B.

The format of the query is

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

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

Name:

_elements

optional

Type:

formData

Data Type:

array

Description:

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

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

Name:

-cursor

optional

Type:

formData

Data Type:

string

Description:

A server internal parameter to navigate different pages.

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

Name:

_count

optional

Type:

formData

Data Type:

integer

Description:

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

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

Sample Value: 30

Name:

_sort

optional

Type:

formData

Data Type:

array

Description:

Request which order results should be returned in.

Supported _sort parameters are:

• date to sort by DiagnosticReport.effective ascending
• -date to sort by DiagnosticReport.effective descending
• issued to sort by DiagnosticReport.issued ascending
• -issued to sort by DiagnosticReport.issued descending
• _lastUpdated to sort by DiagnosticReport.Meta.lastUpdated ascending
• -_lastUpdatedto sort by DiagnosticReport.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 DiagnosticReport resource

Sample Value: shaJRBIXBFUEBY57GNFP6VXO2EJUZVNZQXLOQFUQJBP6WOZPJDFI3VQ

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

Sample Value: shaFUINGXWEMSMKNXPS2WZRNZIKPZFQLBOPGDNWQG3PQI63B6XOT2PA

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:

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

Sample Value: shaFUINGXWEMSMKNXPS2WZRNZIKPZFQLBOPGDNWQG3PQI63B6XOT2PA

Name:

versionid

required

Type:

path

Data Type:

integer

Description:

The version of the DiagnosticReport resource

Sample Value: 1

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:

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.