Skip to content

Latest commit

 

History

History
1128 lines (805 loc) · 27.3 KB

File metadata and controls

1128 lines (805 loc) · 27.3 KB

PrimaryConnectClient::DefaultApi

All URIs are relative to https://connect.primary.health

Method HTTP request Description
accession_order PUT /api/v1/orders/{id}/accession accession order by ULID
accession_order_by_specimen_id PUT /api/v1/orders/accession accession order by Specimen ID
cancel_order DELETE /api/v1/orders/{id} cancel order
create_measurement POST /api/v1/measurements create Measurement
create_order POST /api/v1/orders create order
create_result POST /api/v1/orders/{order_id}/results create result
get_lab_report GET /api/v1/results/{result_id}/lab_report show lab report
get_measurement GET /api/v1/measurements/{id} show measurement
get_order GET /api/v1/orders/{id} show order
list_events GET /api/v1/events list events
list_orders GET /api/v1/orders list orders
list_results GET /api/v1/orders/{order_id}/results list results
reroute_order POST /api/v1/orders/reroute reroute Order identified in the payload
reroute_order_by_ulid POST /api/v1/orders/{id}/reroute Reroute order by ULID
send_query POST /api/v1/queries send query
update_order PUT /api/v1/orders/{id} update order

accession_order

accession_order(id, opts)

accession order by ULID

Examples

require 'time'
require 'primary_connect_client'
# setup authorization
PrimaryConnectClient.configure do |config|
  # Configure Bearer authorization: bearer_auth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = PrimaryConnectClient::DefaultApi.new
id = '01FGD44Q6MVCG2VNSMC4ZMOTQM' # String | Order ID
opts = {
  accession: PrimaryConnectClient::Accession.new # Accession | 
}

begin
  # accession order by ULID
  api_instance.accession_order(id, opts)
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->accession_order: #{e}"
end

Using the accession_order_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> accession_order_with_http_info(id, opts)

begin
  # accession order by ULID
  data, status_code, headers = api_instance.accession_order_with_http_info(id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->accession_order_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id String Order ID
accession Accession [optional]

Return type

nil (empty response body)

Authorization

bearer_auth

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

accession_order_by_specimen_id

accession_order_by_specimen_id(specimen_id, opts)

accession order by Specimen ID

Examples

require 'time'
require 'primary_connect_client'
# setup authorization
PrimaryConnectClient.configure do |config|
  # Configure Bearer authorization: bearer_auth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = PrimaryConnectClient::DefaultApi.new
specimen_id = 'PB123456' # String | Specimen ID
opts = {
  accession: PrimaryConnectClient::Accession.new # Accession | 
}

begin
  # accession order by Specimen ID
  api_instance.accession_order_by_specimen_id(specimen_id, opts)
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->accession_order_by_specimen_id: #{e}"
end

Using the accession_order_by_specimen_id_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> accession_order_by_specimen_id_with_http_info(specimen_id, opts)

begin
  # accession order by Specimen ID
  data, status_code, headers = api_instance.accession_order_by_specimen_id_with_http_info(specimen_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->accession_order_by_specimen_id_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
specimen_id String Specimen ID
accession Accession [optional]

Return type

nil (empty response body)

Authorization

bearer_auth

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

cancel_order

cancel_order(id)

cancel order

Examples

require 'time'
require 'primary_connect_client'
# setup authorization
PrimaryConnectClient.configure do |config|
  # Configure Bearer authorization: bearer_auth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = PrimaryConnectClient::DefaultApi.new
id = '01FGD44Q6MVCG2VNSMC4ZMOTQM' # String | Order ID

begin
  # cancel order
  api_instance.cancel_order(id)
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->cancel_order: #{e}"
end

Using the cancel_order_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> cancel_order_with_http_info(id)

begin
  # cancel order
  data, status_code, headers = api_instance.cancel_order_with_http_info(id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->cancel_order_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id String Order ID

Return type

nil (empty response body)

Authorization

bearer_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

create_measurement

create_measurement

create Measurement

Examples

require 'time'
require 'primary_connect_client'
# setup authorization
PrimaryConnectClient.configure do |config|
  # Configure Bearer authorization: bearer_auth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = PrimaryConnectClient::DefaultApi.new

begin
  # create Measurement
  result = api_instance.create_measurement
  p result
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->create_measurement: #{e}"
end

Using the create_measurement_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> create_measurement_with_http_info

begin
  # create Measurement
  data, status_code, headers = api_instance.create_measurement_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Ids>
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->create_measurement_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

Ids

Authorization

bearer_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

create_order

create_order(opts)

create order

Examples

require 'time'
require 'primary_connect_client'
# setup authorization
PrimaryConnectClient.configure do |config|
  # Configure Bearer authorization: bearer_auth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = PrimaryConnectClient::DefaultApi.new
opts = {
  order: PrimaryConnectClient::Order.new # Order | 
}

begin
  # create order
  result = api_instance.create_order(opts)
  p result
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->create_order: #{e}"
end

Using the create_order_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> create_order_with_http_info(opts)

begin
  # create order
  data, status_code, headers = api_instance.create_order_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <OrderIds>
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->create_order_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
order Order [optional]

Return type

OrderIds

Authorization

bearer_auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

create_result

create_result(order_id, opts)

create result

Examples

require 'time'
require 'primary_connect_client'
# setup authorization
PrimaryConnectClient.configure do |config|
  # Configure Bearer authorization: bearer_auth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = PrimaryConnectClient::DefaultApi.new
order_id = '01FGD44Q6MVCG2VNSMCVX5ZCT6' # String | Order id
opts = {
  results: PrimaryConnectClient::Results.new # Results | 
}

begin
  # create result
  result = api_instance.create_result(order_id, opts)
  p result
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->create_result: #{e}"
end

Using the create_result_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> create_result_with_http_info(order_id, opts)

begin
  # create result
  data, status_code, headers = api_instance.create_result_with_http_info(order_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ResultIds>
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->create_result_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
order_id String Order id
results Results [optional]

Return type

ResultIds

Authorization

bearer_auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

get_lab_report

get_lab_report(result_id)

show lab report

Examples

require 'time'
require 'primary_connect_client'
# setup authorization
PrimaryConnectClient.configure do |config|
  # Configure Bearer authorization: bearer_auth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = PrimaryConnectClient::DefaultApi.new
result_id = '01FGD44Q6MVCG2VNSMC4ZMOTQM' # String | Result id

begin
  # show lab report
  api_instance.get_lab_report(result_id)
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->get_lab_report: #{e}"
end

Using the get_lab_report_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> get_lab_report_with_http_info(result_id)

begin
  # show lab report
  data, status_code, headers = api_instance.get_lab_report_with_http_info(result_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->get_lab_report_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
result_id String Result id

Return type

nil (empty response body)

Authorization

bearer_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_measurement

get_measurement(id)

show measurement

Examples

require 'time'
require 'primary_connect_client'
# setup authorization
PrimaryConnectClient.configure do |config|
  # Configure Bearer authorization: bearer_auth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = PrimaryConnectClient::DefaultApi.new
id = '01FGD44Q6MVCG2VNSMC4ZMOTQM' # String | Measurement ID

begin
  # show measurement
  result = api_instance.get_measurement(id)
  p result
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->get_measurement: #{e}"
end

Using the get_measurement_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_measurement_with_http_info(id)

begin
  # show measurement
  data, status_code, headers = api_instance.get_measurement_with_http_info(id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Measurement>
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->get_measurement_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id String Measurement ID

Return type

Measurement

Authorization

bearer_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_order

get_order(id)

show order

Examples

require 'time'
require 'primary_connect_client'
# setup authorization
PrimaryConnectClient.configure do |config|
  # Configure Bearer authorization: bearer_auth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = PrimaryConnectClient::DefaultApi.new
id = '01FGD44Q6MVCG2VNSMC4ZMOTQM' # String | Order ID

begin
  # show order
  result = api_instance.get_order(id)
  p result
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->get_order: #{e}"
end

Using the get_order_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_order_with_http_info(id)

begin
  # show order
  data, status_code, headers = api_instance.get_order_with_http_info(id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <OrderWithEventErrors>
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->get_order_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id String Order ID

Return type

OrderWithEventErrors

Authorization

bearer_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

list_events

list_events(opts)

list events

Examples

require 'time'
require 'primary_connect_client'
# setup authorization
PrimaryConnectClient.configure do |config|
  # Configure Bearer authorization: bearer_auth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = PrimaryConnectClient::DefaultApi.new
opts = {
  last_event_id: '01FGD30NTPNNZE9MKGMWZGHGTZ', # String | Paginate events with event id. 26 character, sortable id.
  event_types: 'OrderCreated,OrderComplete' # String | Filter event_types, comma delimited. [OrderComplete, OrderCreated, OrderError, OrderResulted, OrderUpdated, ResultError, SpecimenReceived]
}

begin
  # list events
  result = api_instance.list_events(opts)
  p result
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->list_events: #{e}"
end

Using the list_events_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> list_events_with_http_info(opts)

begin
  # list events
  data, status_code, headers = api_instance.list_events_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Events>
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->list_events_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
last_event_id String Paginate events with event id. 26 character, sortable id. [optional]
event_types String Filter event_types, comma delimited. [OrderComplete, OrderCreated, OrderError, OrderResulted, OrderUpdated, ResultError, SpecimenReceived] [optional]

Return type

Events

Authorization

bearer_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

list_orders

list_orders(opts)

list orders

Examples

require 'time'
require 'primary_connect_client'
# setup authorization
PrimaryConnectClient.configure do |config|
  # Configure Bearer authorization: bearer_auth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = PrimaryConnectClient::DefaultApi.new
opts = {
  last_order_id: '01FGD30NTPNNZE9MKGMWZGHGTZ', # String | Paginate orders with order id. 26 character, sortable id.
  state: 'new,resulted', # String | Filter orders by state, comma delimited.[new, updated, delivered, processing, resulted, errored, canceled, unprocessable]
  specimen_id: 'PB1234567', # String | Find an order by specimen/accession id. If found, will redirect to show order endpoint.
  without_order_body: true, # Boolean | Exclude order body from the response
  sent_only: true, # Boolean | Filter orders sent by the current entity
  received_only: true # Boolean | Filter orders received by the current entity
}

begin
  # list orders
  result = api_instance.list_orders(opts)
  p result
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->list_orders: #{e}"
end

Using the list_orders_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> list_orders_with_http_info(opts)

begin
  # list orders
  data, status_code, headers = api_instance.list_orders_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Orders>
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->list_orders_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
last_order_id String Paginate orders with order id. 26 character, sortable id. [optional]
state String Filter orders by state, comma delimited.[new, updated, delivered, processing, resulted, errored, canceled, unprocessable] [optional]
specimen_id String Find an order by specimen/accession id. If found, will redirect to show order endpoint. [optional]
without_order_body Boolean Exclude order body from the response [optional]
sent_only Boolean Filter orders sent by the current entity [optional]
received_only Boolean Filter orders received by the current entity [optional]

Return type

Orders

Authorization

bearer_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

list_results

list_results(order_id)

list results

Examples

require 'time'
require 'primary_connect_client'
# setup authorization
PrimaryConnectClient.configure do |config|
  # Configure Bearer authorization: bearer_auth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = PrimaryConnectClient::DefaultApi.new
order_id = '01FGD44Q6MVCG2VNSMCVX5ZCT6' # String | Order id

begin
  # list results
  result = api_instance.list_results(order_id)
  p result
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->list_results: #{e}"
end

Using the list_results_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> list_results_with_http_info(order_id)

begin
  # list results
  data, status_code, headers = api_instance.list_results_with_http_info(order_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Results>
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->list_results_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
order_id String Order id

Return type

Results

Authorization

bearer_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

reroute_order

reroute_order(opts)

reroute Order identified in the payload

Examples

require 'time'
require 'primary_connect_client'
# setup authorization
PrimaryConnectClient.configure do |config|
  # Configure Bearer authorization: bearer_auth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = PrimaryConnectClient::DefaultApi.new
opts = {
  order: PrimaryConnectClient::Order.new # Order | 
}

begin
  # reroute Order identified in the payload
  api_instance.reroute_order(opts)
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->reroute_order: #{e}"
end

Using the reroute_order_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> reroute_order_with_http_info(opts)

begin
  # reroute Order identified in the payload
  data, status_code, headers = api_instance.reroute_order_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->reroute_order_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
order Order [optional]

Return type

nil (empty response body)

Authorization

bearer_auth

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

reroute_order_by_ulid

reroute_order_by_ulid(id, opts)

Reroute order by ULID

Examples

require 'time'
require 'primary_connect_client'
# setup authorization
PrimaryConnectClient.configure do |config|
  # Configure Bearer authorization: bearer_auth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = PrimaryConnectClient::DefaultApi.new
id = '01FGD44Q6MVCG2VNSMC4ZMOTQM' # String | Order ID
opts = {
  order: PrimaryConnectClient::Order.new # Order | 
}

begin
  # Reroute order by ULID
  api_instance.reroute_order_by_ulid(id, opts)
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->reroute_order_by_ulid: #{e}"
end

Using the reroute_order_by_ulid_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> reroute_order_by_ulid_with_http_info(id, opts)

begin
  # Reroute order by ULID
  data, status_code, headers = api_instance.reroute_order_by_ulid_with_http_info(id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->reroute_order_by_ulid_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id String Order ID
order Order [optional]

Return type

nil (empty response body)

Authorization

bearer_auth

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

send_query

send_query(opts)

send query

Examples

require 'time'
require 'primary_connect_client'
# setup authorization
PrimaryConnectClient.configure do |config|
  # Configure Bearer authorization: bearer_auth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = PrimaryConnectClient::DefaultApi.new
opts = {
  query: PrimaryConnectClient::Query.new # Query | 
}

begin
  # send query
  result = api_instance.send_query(opts)
  p result
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->send_query: #{e}"
end

Using the send_query_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> send_query_with_http_info(opts)

begin
  # send query
  data, status_code, headers = api_instance.send_query_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ImmunizationQueryResponse>
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->send_query_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
query Query [optional]

Return type

ImmunizationQueryResponse

Authorization

bearer_auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

update_order

update_order(id, opts)

update order

Examples

require 'time'
require 'primary_connect_client'
# setup authorization
PrimaryConnectClient.configure do |config|
  # Configure Bearer authorization: bearer_auth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = PrimaryConnectClient::DefaultApi.new
id = '01FGD44Q6MVCG2VNSMC4ZMOTQM' # String | Order ID
opts = {
  order: PrimaryConnectClient::Order.new # Order | 
}

begin
  # update order
  result = api_instance.update_order(id, opts)
  p result
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->update_order: #{e}"
end

Using the update_order_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> update_order_with_http_info(id, opts)

begin
  # update order
  data, status_code, headers = api_instance.update_order_with_http_info(id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <OrderIds>
rescue PrimaryConnectClient::ApiError => e
  puts "Error when calling DefaultApi->update_order_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id String Order ID
order Order [optional]

Return type

OrderIds

Authorization

bearer_auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json