primary_connect_client 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87215c1bba59cc60aff1c1838ea092541fc494b5625fc9bdee05c8636b5b1574
-  data.tar.gz: a91593b598df16d40d875466ccda08c2dd6eb26b0ba155a3ccdf74fbd6fc2c74
+  metadata.gz: 2fba2c726308c0fd123e99a5d2ceca4efc2f9dc09d9b572809e7a44480efd46a
+  data.tar.gz: 162b1b9fad3431aaa2d20cc0610aac70982cb781c9a1527fceb8cfd686e07ded
 SHA512:
-  metadata.gz: 3d9361eac5551d6b08d3b8e5d6623f7d378e858402f5d7badc63c9236a657582557e2064fefd898307eace4588154f143704e639bf990af54545f6bab402bf9b
-  data.tar.gz: 0c5fb396166240dfa70dd950863e6e25408272d27bd3dfac2db71829c8811d86498f99ad6a1dbc7f679db3d6940266e6dc296f0b5b3f369c7e67552c556d9fb2
+  metadata.gz: 925c18ed682db7211dec940a87cff4ece2f31ac66e91f3e74ef00acd8223fcba7e04c69378d6a8ebb6c59e10b2f6dfd74943d9c5b3e9ef7e3b32fd323f4794da
+  data.tar.gz: bdeb83007e34eac9b0fa1c72f9ece5b9b1f550e5040feaf28bb7e0944cd2b4ca3e4936477bcb9e5002679dcb479d85022ef1f04bb2d141df286b8afae2095faf

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change Log
 
+## 1.5.0
+
+- Updated dependency on `primary_connect_proto` 0.17.0
+- Added Measurement API
+- Added Order.Procedures
+
+## 1.4.0
+
+- Updated dependency on `primary_connect_proto` 0.15.0
+
 ## 1.3.0
 
 - Updated dependency on `primary_connect_proto` 0.13.0

data/README.md

@@ -7,7 +7,7 @@ Client Library to interface with Primary Connect
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: v1
-- Package version: 1.3.0
+- Package version: 1.5.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -23,16 +23,16 @@ gem build primary_connect_client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./primary_connect_client-1.3.0.gem
+gem install ./primary_connect_client-1.5.0.gem
 ```
 
-(for development, run `gem install --dev ./primary_connect_client-1.3.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./primary_connect_client-1.5.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'primary_connect_client', '~> 1.3.0'
+    gem 'primary_connect_client', '~> 1.5.0'
 
 ### Install from Git
 
@@ -64,12 +64,15 @@ end
 
 api_instance = PrimaryConnectClient::DefaultApi.new
 id = '01FGD44Q6MVCG2VNSMC4ZMOTQM' # String | Order ID
+opts = {
+  accession: PrimaryConnectClient::Accession.new # Accession | 
+}
 
 begin
-  #cancel order
-  api_instance.cancel_order(id)
+  #accession order by ULID
+  api_instance.accession_order(id, opts)
 rescue PrimaryConnectClient::ApiError => e
-  puts "Exception when calling DefaultApi->cancel_order: #{e}"
+  puts "Exception when calling DefaultApi->accession_order: #{e}"
 end
 
 ```
@@ -80,10 +83,14 @@ All URIs are relative to *https://connect.primary.health*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
+*PrimaryConnectClient::DefaultApi* | [**accession_order**](docs/DefaultApi.md#accession_order) | **PUT** /api/v1/orders/{id}/accession | accession order by ULID
+*PrimaryConnectClient::DefaultApi* | [**accession_order_by_specimen_id**](docs/DefaultApi.md#accession_order_by_specimen_id) | **PUT** /api/v1/orders/accession | accession order by Specimen ID
 *PrimaryConnectClient::DefaultApi* | [**cancel_order**](docs/DefaultApi.md#cancel_order) | **DELETE** /api/v1/orders/{id} | cancel order
+*PrimaryConnectClient::DefaultApi* | [**create_measurement**](docs/DefaultApi.md#create_measurement) | **POST** /api/v1/measurements | create Measurement
 *PrimaryConnectClient::DefaultApi* | [**create_order**](docs/DefaultApi.md#create_order) | **POST** /api/v1/orders | create order
 *PrimaryConnectClient::DefaultApi* | [**create_result**](docs/DefaultApi.md#create_result) | **POST** /api/v1/orders/{order_id}/results | create result
 *PrimaryConnectClient::DefaultApi* | [**get_lab_report**](docs/DefaultApi.md#get_lab_report) | **GET** /api/v1/results/{result_id}/lab_report | show lab report
+*PrimaryConnectClient::DefaultApi* | [**get_measurement**](docs/DefaultApi.md#get_measurement) | **GET** /api/v1/measurements/{id} | show measurement
 *PrimaryConnectClient::DefaultApi* | [**get_order**](docs/DefaultApi.md#get_order) | **GET** /api/v1/orders/{id} | show order
 *PrimaryConnectClient::DefaultApi* | [**list_events**](docs/DefaultApi.md#list_events) | **GET** /api/v1/events | list events
 *PrimaryConnectClient::DefaultApi* | [**list_orders**](docs/DefaultApi.md#list_orders) | **GET** /api/v1/orders | list orders
@@ -93,6 +100,8 @@ Class | Method | HTTP request | Description
 
 ## Documentation for Models
 
+ - [PrimaryConnectClient::Accession](docs/Accession.md)
+ - [PrimaryConnectClient::AccessionOrder](docs/AccessionOrder.md)
  - [PrimaryConnectClient::Address](docs/Address.md)
  - [PrimaryConnectClient::CodedValue](docs/CodedValue.md)
  - [PrimaryConnectClient::Demographics](docs/Demographics.md)
@@ -102,7 +111,9 @@ Class | Method | HTTP request | Description
  - [PrimaryConnectClient::Event](docs/Event.md)
  - [PrimaryConnectClient::Events](docs/Events.md)
  - [PrimaryConnectClient::Identifier](docs/Identifier.md)
+ - [PrimaryConnectClient::Ids](docs/Ids.md)
  - [PrimaryConnectClient::Location](docs/Location.md)
+ - [PrimaryConnectClient::Measurement](docs/Measurement.md)
  - [PrimaryConnectClient::Medication](docs/Medication.md)
  - [PrimaryConnectClient::MedicationAdministration](docs/MedicationAdministration.md)
  - [PrimaryConnectClient::Meta](docs/Meta.md)

data/docs/Accession.md

@@ -0,0 +1,18 @@
+# PrimaryConnectClient::Accession
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **order** | [**AccessionOrder**](AccessionOrder.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::Accession.new(
+  order: null
+)
+```
+

data/docs/AccessionOrder.md

@@ -0,0 +1,18 @@
+# PrimaryConnectClient::AccessionOrder
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **accession_date_time** | **Time** | Timestamp when the specimen was received by the destination. (ISO-8601) | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::AccessionOrder.new(
+  accession_date_time: 2021-07-10T12:35:45-07:00
+)
+```
+

data/docs/DefaultApi.md

@@ -4,10 +4,14 @@ All URIs are relative to *https://connect.primary.health*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**accession_order**](DefaultApi.md#accession_order) | **PUT** /api/v1/orders/{id}/accession | accession order by ULID |
+| [**accession_order_by_specimen_id**](DefaultApi.md#accession_order_by_specimen_id) | **PUT** /api/v1/orders/accession | accession order by Specimen ID |
 | [**cancel_order**](DefaultApi.md#cancel_order) | **DELETE** /api/v1/orders/{id} | cancel order |
+| [**create_measurement**](DefaultApi.md#create_measurement) | **POST** /api/v1/measurements | create Measurement |
 | [**create_order**](DefaultApi.md#create_order) | **POST** /api/v1/orders | create order |
 | [**create_result**](DefaultApi.md#create_result) | **POST** /api/v1/orders/{order_id}/results | create result |
 | [**get_lab_report**](DefaultApi.md#get_lab_report) | **GET** /api/v1/results/{result_id}/lab_report | show lab report |
+| [**get_measurement**](DefaultApi.md#get_measurement) | **GET** /api/v1/measurements/{id} | show measurement |
 | [**get_order**](DefaultApi.md#get_order) | **GET** /api/v1/orders/{id} | show order |
 | [**list_events**](DefaultApi.md#list_events) | **GET** /api/v1/events | list events |
 | [**list_orders**](DefaultApi.md#list_orders) | **GET** /api/v1/orders | list orders |
@@ -15,6 +19,146 @@ All URIs are relative to *https://connect.primary.health*
 | [**update_order**](DefaultApi.md#update_order) | **PUT** /api/v1/orders/{id} | update order |
 
 
+## accession_order
+
+> accession_order(id, opts)
+
+accession order by ULID
+
+### Examples
+
+```ruby
+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)
+
+```ruby
+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**](Accession.md) |  | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#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
+
+```ruby
+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)
+
+```ruby
+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**](Accession.md) |  | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+
+
 ## cancel_order
 
 > cancel_order(id)
@@ -81,6 +225,70 @@ nil (empty response body)
 - **Accept**: application/json
 
 
+## create_measurement
+
+> <Ids> create_measurement
+
+create Measurement
+
+### Examples
+
+```ruby
+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(<Ids>, Integer, Hash)> create_measurement_with_http_info
+
+```ruby
+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**](Ids.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## create_order
 
 > <OrderIds> create_order(opts)
@@ -287,6 +495,73 @@ nil (empty response body)
 - **Accept**: application/json
 
 
+## get_measurement
+
+> <Measurement> get_measurement(id)
+
+show measurement
+
+### Examples
+
+```ruby
+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(<Measurement>, Integer, Hash)> get_measurement_with_http_info(id)
+
+```ruby
+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**](Measurement.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_order
 
 > <OrderWithEventErrors> get_order(id)

data/docs/Device.md

@@ -4,13 +4,14 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **device_id** | [**Array<Identifier>**](Identifier.md) | Identifier used to identify the device | [optional] |
+| **identifiers** | [**Array<Identifier>**](Identifier.md) | List of IDs and types that identify the device | [optional] |
 | **manufacturer** | **String** |  | [optional] |
 | **model_number** | **String** |  | [optional] |
 | **serial_number** | **String** |  | [optional] |
 | **address** | [**Address**](Address.md) |  | [optional] |
 | **location** | [**Location**](Location.md) |  | [optional] |
 | **config** | **Object** | Arbitrary key/value pairs for Device specific use | [optional] |
+| **model_name** | **String** |  | [optional] |
 
 ## Example
 
@@ -18,13 +19,14 @@
 require 'primary_connect_client'
 
 instance = PrimaryConnectClient::Device.new(
-  device_id: null,
+  identifiers: null,
   manufacturer: null,
   model_number: null,
   serial_number: null,
   address: null,
   location: null,
-  config: {"key1":"value1","key2":"value2"}
+  config: {"key1":"value1","key2":"value2"},
+  model_name: null
 )
 ```
 

data/docs/Ids.md

@@ -0,0 +1,18 @@
+# PrimaryConnectClient::Ids
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ids** | **Array<String>** | List of IDs | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::Ids.new(
+  ids: null
+)
+```
+

data/docs/Measurement.md

@@ -0,0 +1,22 @@
+# PrimaryConnectClient::Measurement
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **meta** | [**Meta**](Meta.md) |  | [optional] |
+| **subject** | [**Subject**](Subject.md) |  | [optional] |
+| **metrics** | [**Array<Result>**](Result.md) | List of result components | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::Measurement.new(
+  meta: null,
+  subject: null,
+  metrics: null
+)
+```
+

data/docs/OrderOrder.md

@@ -11,10 +11,12 @@
 | **collection_date_time** | **Time** | Timestamp when the specimen was collected (ISO-8601) | [optional] |
 | **collection_start_date_time** | **Time** | Timestamp when the specimen was collected (ISO-8601) | [optional] |
 | **completion_date_time** | **Time** | Timestamp when the results were composed into a report and released. (ISO-8601) | [optional] |
+| **accession_date_time** | **Time** | Timestamp when the specimen was received by the destination. (ISO-8601) | [optional] |
 | **expiration_date** | **String** | YYYY-MM-DD, Date when the order becomes invalid | [optional] |
 | **specimen** | [**Specimen**](Specimen.md) |  | [optional] |
 | **medication_administrations** | [**Array<MedicationAdministration>**](MedicationAdministration.md) | Array of medications administered to the subject | [optional] |
 | **procedure** | [**CodedValue**](CodedValue.md) |  | [optional] |
+| **procedures** | [**Array<CodedValues>**](CodedValues.md) | Array of Procedures ordered | [optional] |
 | **ordering_provider** | [**Provider**](Provider.md) |  | [optional] |
 | **result_copy_providers** | [**Array<Provider>**](Provider.md) | Array of providers to be copied on the results | [optional] |
 | **ordering_facility** | [**OrderOrderOrderingFacility**](OrderOrderOrderingFacility.md) |  | [optional] |
@@ -41,10 +43,12 @@ instance = PrimaryConnectClient::OrderOrder.new(
   collection_date_time: 2021-07-10T12:35:45-07:00,
   collection_start_date_time: 2021-07-10T12:35:45-07:00,
   completion_date_time: 2021-07-10T12:35:45-07:00,
+  accession_date_time: 2021-07-10T12:35:45-07:00,
   expiration_date: 2022-05-23,
   specimen: null,
   medication_administrations: null,
   procedure: null,
+  procedures: null,
   ordering_provider: null,
   result_copy_providers: null,
   ordering_facility: null,

data/docs/Result.md

@@ -22,6 +22,7 @@
 | **observation_method** | [**CodedValue**](CodedValue.md) |  | [optional] |
 | **producer_order_id** | **String** | Unique ID generated by resulting entity | [optional] |
 | **finding_value** | [**CodedValue**](CodedValue.md) |  | [optional] |
+| **resulting_device** | [**Device**](Device.md) |  | [optional] |
 
 ## Example
 
@@ -46,7 +47,8 @@ instance = PrimaryConnectClient::Result.new(
   reference_range: null,
   observation_method: null,
   producer_order_id: 12345678,
-  finding_value: null
+  finding_value: null,
+  resulting_device: null
 )
 ```
 

data/docs/V2Device.md

@@ -4,13 +4,14 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **device_id** | [**Array<Identifier>**](Identifier.md) | Identifier used to identify the device | [optional] |
+| **identifiers** | [**Array<Identifier>**](Identifier.md) | List of IDs and types that identify the device | [optional] |
 | **manufacturer** | **String** |  | [optional] |
 | **model_number** | **String** |  | [optional] |
 | **serial_number** | **String** |  | [optional] |
 | **address** | [**Address**](Address.md) |  | [optional] |
 | **location** | [**Location**](Location.md) |  | [optional] |
 | **config** | **Object** | Arbitrary key/value pairs for Device specific use | [optional] |
+| **model_name** | **String** |  | [optional] |
 
 ## Example
 
@@ -18,13 +19,14 @@
 require 'primary_connect_client'
 
 instance = PrimaryConnectClient::V2Device.new(
-  device_id: null,
+  identifiers: null,
   manufacturer: null,
   model_number: null,
   serial_number: null,
   address: null,
   location: null,
-  config: {"key1":"value1","key2":"value2"}
+  config: {"key1":"value1","key2":"value2"},
+  model_name: null
 )
 ```