primary_connect_client 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e0055d5e48142beffc8ab7495ddc20d455c2f9c4b0dbccb34ba3e71abd7c752
-  data.tar.gz: 496b7bc07a672a590c32e7ef4f54ffe545ebf4a300d557a264fd217ccfbdce78
+  metadata.gz: 6e97230d501669e4f2fdc73dc7a4193eac7f984816b2d7b577e55119b97543e2
+  data.tar.gz: 92e1d11353a0250b67597a84209faf38154b71f613e2ef647ac294ab6e130297
 SHA512:
-  metadata.gz: b4e3c8339be5d814559b62ed300dd503b6ae7503334b86bf3dbf57399679b3c45193fc3745413f7c93e8a8f82150f7608e180206decd9dfafe42f230a4465dc0
-  data.tar.gz: 588ccf17788e6ead3147345242a419f066f96634e43756cba7dabbc305f2d44088231f8f1e9b2cc5cdbb56cee124ff12a7ff4f31d7638d119f8c9c33929296a8
+  metadata.gz: 702a5b8d2d4e29c106f8333ce0472619f86e02b6936bea117bf37fe97f9725f0b46287f29df739953c28997d5f8a3c070d89e981295b29026a47e1579d09b50e
+  data.tar.gz: 732f778977db83a9bb8e90e36eee74831b17096923cb94a3192fa2c70255e7f2f70c4c4f3873a9c8f9b336e421eb5caf554c0176fe718a471cf97de9d1b46b39

data/CHANGELOG.md

@@ -1,8 +1,14 @@
 # Change Log
 
+## 1.2.0
+
+- Updated models with `primary_connect_proto` 0.12.0
+- Restored strict dependency on `primary_connect_proto` due to
+models having to match the proto definition
+
 ## 1.1.0
 
-- Added cancel_order
+- Added `cancel_order`
 
 ## 1.0.1
 

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.1.0
+- Package version: 1.2.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.1.0.gem
+gem install ./primary_connect_client-1.2.0.gem
 ```
 
-(for development, run `gem install --dev ./primary_connect_client-1.1.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./primary_connect_client-1.2.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.1.0'
+    gem 'primary_connect_client', '~> 1.2.0'
 
 ### Install from Git
 
@@ -96,11 +96,15 @@ Class | Method | HTTP request | Description
  - [PrimaryConnectClient::Address](docs/Address.md)
  - [PrimaryConnectClient::CodedValue](docs/CodedValue.md)
  - [PrimaryConnectClient::Demographics](docs/Demographics.md)
+ - [PrimaryConnectClient::Device](docs/Device.md)
+ - [PrimaryConnectClient::Dosage](docs/Dosage.md)
  - [PrimaryConnectClient::Error](docs/Error.md)
  - [PrimaryConnectClient::Event](docs/Event.md)
  - [PrimaryConnectClient::Events](docs/Events.md)
  - [PrimaryConnectClient::Identifier](docs/Identifier.md)
  - [PrimaryConnectClient::Location](docs/Location.md)
+ - [PrimaryConnectClient::Medication](docs/Medication.md)
+ - [PrimaryConnectClient::MedicationAdministration](docs/MedicationAdministration.md)
  - [PrimaryConnectClient::Meta](docs/Meta.md)
  - [PrimaryConnectClient::MetaDestinations](docs/MetaDestinations.md)
  - [PrimaryConnectClient::MetaMessage](docs/MetaMessage.md)
@@ -126,6 +130,13 @@ Class | Method | HTTP request | Description
  - [PrimaryConnectClient::ResultReport](docs/ResultReport.md)
  - [PrimaryConnectClient::Results](docs/Results.md)
  - [PrimaryConnectClient::Specimen](docs/Specimen.md)
+ - [PrimaryConnectClient::Subject](docs/Subject.md)
+ - [PrimaryConnectClient::SubjectOneOf](docs/SubjectOneOf.md)
+ - [PrimaryConnectClient::SubjectOneOf1](docs/SubjectOneOf1.md)
+ - [PrimaryConnectClient::V2Device](docs/V2Device.md)
+ - [PrimaryConnectClient::V2Dosage](docs/V2Dosage.md)
+ - [PrimaryConnectClient::V2Medication](docs/V2Medication.md)
+ - [PrimaryConnectClient::V2MedicationAdministration](docs/V2MedicationAdministration.md)
  - [PrimaryConnectClient::Visit](docs/Visit.md)
  - [PrimaryConnectClient::VisitCompany](docs/VisitCompany.md)
  - [PrimaryConnectClient::VisitGuarantor](docs/VisitGuarantor.md)

data/docs/DefaultApi.md

@@ -170,7 +170,7 @@ end
 api_instance = PrimaryConnectClient::DefaultApi.new
 order_id = '01FGD44Q6MVCG2VNSMCVX5ZCT6' # String | Order id
 opts = {
-  result: PrimaryConnectClient::Result.new # Result | 
+  results: PrimaryConnectClient::Results.new # Results | 
 }
 
 begin
@@ -205,7 +205,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **order_id** | **String** | Order id |  |
-| **result** | [**Result**](Result.md) |  | [optional] |
+| **results** | [**Results**](Results.md) |  | [optional] |
 
 ### Return type
 
@@ -445,7 +445,8 @@ 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]
+  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.
 }
 
 begin
@@ -481,6 +482,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **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] |
 
 ### Return type
 

data/docs/Device.md

@@ -0,0 +1,30 @@
+# PrimaryConnectClient::Device
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **device_id** | [**Array<Identifier>**](Identifier.md) | Identifier used to 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] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::Device.new(
+  device_id: null,
+  manufacturer: null,
+  model_number: null,
+  serial_number: null,
+  address: null,
+  location: null,
+  config: {"key1":"value1","key2":"value2"}
+)
+```
+

data/docs/Dosage.md

@@ -0,0 +1,30 @@
+# PrimaryConnectClient::Dosage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **site** | [**CodedValue**](CodedValue.md) |  | [optional] |
+| **route** | [**CodedValue**](CodedValue.md) |  | [optional] |
+| **method** | [**CodedValue**](CodedValue.md) |  | [optional] |
+| **dose** | **String** | Amount of medication per dose | [optional] |
+| **units** | [**CodedValue**](CodedValue.md) |  | [optional] |
+| **series_number** | **String** | Dose number administered within series_recommended | [optional] |
+| **series_recommended** | **String** | Number of recommended doses in a prescribed series | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::Dosage.new(
+  site: null,
+  route: null,
+  method: null,
+  dose: null,
+  units: null,
+  series_number: null,
+  series_recommended: null
+)
+```
+

data/docs/Location.md

@@ -9,6 +9,7 @@
 | **department** | **String** |  | [optional] |
 | **room** | **String** |  | [optional] |
 | **bed** | **String** |  | [optional] |
+| **floor** | **String** |  | [optional] |
 
 ## Example
 
@@ -20,7 +21,8 @@ instance = PrimaryConnectClient::Location.new(
   facility: Community Hospital,
   department: null,
   room: 136,
-  bed: B
+  bed: B,
+  floor: 10
 )
 ```
 

data/docs/Medication.md

@@ -0,0 +1,22 @@
+# PrimaryConnectClient::Medication
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lot_number** | **String** | Lot number product component | [optional] |
+| **expiration_date** | **Time** | Product expiration date | [optional] |
+| **manufacturer** | [**CodedValue**](CodedValue.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::Medication.new(
+  lot_number: null,
+  expiration_date: 2021-07-10T12:35:45-07:00,
+  manufacturer: null
+)
+```
+

data/docs/MedicationAdministration.md

@@ -0,0 +1,32 @@
+# PrimaryConnectClient::MedicationAdministration
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identifier** | [**Identifier**](Identifier.md) |  | [optional] |
+| **administration_codes** | [**Array<CodedValue>**](CodedValue.md) | Codes for the medication administration | [optional] |
+| **administration_start_time** | **Time** | Administration start date of medication | [optional] |
+| **administration_end_time** | **Time** | Administration end date of medication | [optional] |
+| **medication** | [**Medication**](Medication.md) |  | [optional] |
+| **dosage** | [**Dosage**](Dosage.md) |  | [optional] |
+| **refusal_reason** | [**CodedValue**](CodedValue.md) |  | [optional] |
+| **administering_provider** | [**Provider**](Provider.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::MedicationAdministration.new(
+  identifier: null,
+  administration_codes: null,
+  administration_start_time: 2021-07-10T12:35:45-07:00,
+  administration_end_time: 2021-07-10T12:35:45-07:00,
+  medication: null,
+  dosage: null,
+  refusal_reason: null,
+  administering_provider: null
+)
+```
+

data/docs/Order.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **patient** | [**Patient**](Patient.md) |  | [optional] |
+| **subject** | [**Subject**](Subject.md) |  | [optional] |
 | **visit** | [**Visit**](Visit.md) |  | [optional] |
 | **meta** | [**Meta**](Meta.md) |  | [optional] |
 | **order** | [**OrderOrder**](OrderOrder.md) |  | [optional] |
@@ -16,6 +17,7 @@ require 'primary_connect_client'
 
 instance = PrimaryConnectClient::Order.new(
   patient: null,
+  subject: null,
   visit: null,
   meta: null,
   order: null

data/docs/OrderOrder.md

@@ -9,9 +9,11 @@
 | **status** | **String** | The status of an order. | [optional] |
 | **transaction_date_time** | **Time** | Timestamp when the order was placed | [optional] |
 | **collection_date_time** | **Time** | Timestamp when the specimen was collected | [optional] |
+| **collection_start_date_time** | **Time** | Timestamp when the specimen was collected | [optional] |
 | **completion_date_time** | **Time** | Timestamp when the results were composed into a report and released. | [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] |
 | **ordering_provider** | [**Provider**](Provider.md) |  | [optional] |
 | **result_copy_providers** | [**Array<Provider>**](Provider.md) | Array of providers to be copied on the results | [optional] |
@@ -37,9 +39,11 @@ instance = PrimaryConnectClient::OrderOrder.new(
   status: null,
   transaction_date_time: 2021-07-10T12:35:45-07:00,
   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,
   expiration_date: 2022-05-23,
   specimen: null,
+  medication_administrations: null,
   procedure: null,
   ordering_provider: null,
   result_copy_providers: null,

data/docs/Subject.md

@@ -0,0 +1,49 @@
+# PrimaryConnectClient::Subject
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'primary_connect_client'
+
+PrimaryConnectClient::Subject.openapi_one_of
+# =>
+# [
+#   :'SubjectOneOf',
+#   :'SubjectOneOf1'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'primary_connect_client'
+
+PrimaryConnectClient::Subject.build(data)
+# => #<SubjectOneOf:0x00007fdd4aab02a0>
+
+PrimaryConnectClient::Subject.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `SubjectOneOf`
+- `SubjectOneOf1`
+- `nil` (if no type matches)
+

data/docs/SubjectOneOf.md

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

data/docs/SubjectOneOf1.md

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

data/docs/V2Device.md

@@ -0,0 +1,30 @@
+# PrimaryConnectClient::V2Device
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **device_id** | [**Array<Identifier>**](Identifier.md) | Identifier used to 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] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::V2Device.new(
+  device_id: null,
+  manufacturer: null,
+  model_number: null,
+  serial_number: null,
+  address: null,
+  location: null,
+  config: {"key1":"value1","key2":"value2"}
+)
+```
+

data/docs/V2Dosage.md

@@ -0,0 +1,30 @@
+# PrimaryConnectClient::V2Dosage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **site** | [**CodedValue**](CodedValue.md) |  | [optional] |
+| **route** | [**CodedValue**](CodedValue.md) |  | [optional] |
+| **method** | [**CodedValue**](CodedValue.md) |  | [optional] |
+| **dose** | **String** | Amount of medication per dose | [optional] |
+| **units** | [**CodedValue**](CodedValue.md) |  | [optional] |
+| **series_number** | **String** | Dose number administered within series_recommended | [optional] |
+| **series_recommended** | **String** | Number of recommended doses in a prescribed series | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::V2Dosage.new(
+  site: null,
+  route: null,
+  method: null,
+  dose: null,
+  units: null,
+  series_number: null,
+  series_recommended: null
+)
+```
+

data/docs/V2Medication.md

@@ -0,0 +1,22 @@
+# PrimaryConnectClient::V2Medication
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lot_number** | **String** | Lot number product component | [optional] |
+| **expiration_date** | **Time** | Product expiration date | [optional] |
+| **manufacturer** | [**CodedValue**](CodedValue.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::V2Medication.new(
+  lot_number: null,
+  expiration_date: 2021-07-10T12:35:45-07:00,
+  manufacturer: null
+)
+```
+

data/docs/V2MedicationAdministration.md

@@ -0,0 +1,32 @@
+# PrimaryConnectClient::V2MedicationAdministration
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identifier** | [**Identifier**](Identifier.md) |  | [optional] |
+| **administration_codes** | [**Array<CodedValue>**](CodedValue.md) | Codes for the medication administration | [optional] |
+| **administration_start_time** | **Time** | Administration start date of medication | [optional] |
+| **administration_end_time** | **Time** | Administration end date of medication | [optional] |
+| **medication** | [**Medication**](Medication.md) |  | [optional] |
+| **dosage** | [**Dosage**](Dosage.md) |  | [optional] |
+| **refusal_reason** | [**CodedValue**](CodedValue.md) |  | [optional] |
+| **administering_provider** | [**Provider**](Provider.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::V2MedicationAdministration.new(
+  identifier: null,
+  administration_codes: null,
+  administration_start_time: 2021-07-10T12:35:45-07:00,
+  administration_end_time: 2021-07-10T12:35:45-07:00,
+  medication: null,
+  dosage: null,
+  refusal_reason: null,
+  administering_provider: null
+)
+```
+

data/lib/primary_connect_client/api/default_api.rb

@@ -145,7 +145,7 @@ module PrimaryConnectClient
     # create result
     # @param order_id [String] Order id
     # @param [Hash] opts the optional parameters
-    # @option opts [Result] :result 
+    # @option opts [Results] :results 
     # @return [ResultIds]
     def create_result(order_id, opts = {})
       data, _status_code, _headers = create_result_with_http_info(order_id, opts)
@@ -155,7 +155,7 @@ module PrimaryConnectClient
     # create result
     # @param order_id [String] Order id
     # @param [Hash] opts the optional parameters
-    # @option opts [Result] :result 
+    # @option opts [Results] :results 
     # @return [Array<(ResultIds, Integer, Hash)>] ResultIds data, response status code and response headers
     def create_result_with_http_info(order_id, opts = {})
       if @api_client.config.debugging
@@ -185,7 +185,7 @@ module PrimaryConnectClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'result'])
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'results'])
 
       # return_type
       return_type = opts[:debug_return_type] || 'ResultIds'
@@ -397,6 +397,7 @@ module PrimaryConnectClient
     # @param [Hash] opts the optional parameters
     # @option opts [String] :last_order_id Paginate orders with order id. 26 character, sortable id.
     # @option opts [String] :state Filter orders by state, comma delimited.[new, updated, delivered, processing, resulted, errored, canceled, unprocessable]
+    # @option opts [String] :specimen_id Find an order by specimen/accession id. If found, will redirect to show order endpoint.
     # @return [Orders]
     def list_orders(opts = {})
       data, _status_code, _headers = list_orders_with_http_info(opts)
@@ -407,6 +408,7 @@ module PrimaryConnectClient
     # @param [Hash] opts the optional parameters
     # @option opts [String] :last_order_id Paginate orders with order id. 26 character, sortable id.
     # @option opts [String] :state Filter orders by state, comma delimited.[new, updated, delivered, processing, resulted, errored, canceled, unprocessable]
+    # @option opts [String] :specimen_id Find an order by specimen/accession id. If found, will redirect to show order endpoint.
     # @return [Array<(Orders, Integer, Hash)>] Orders data, response status code and response headers
     def list_orders_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -419,6 +421,7 @@ module PrimaryConnectClient
       query_params = opts[:query_params] || {}
       query_params[:'last_order_id'] = opts[:'last_order_id'] if !opts[:'last_order_id'].nil?
       query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
+      query_params[:'specimen_id'] = opts[:'specimen_id'] if !opts[:'specimen_id'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}