primary_connect_client 0.8.0 → 1.2.0

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/Error.md

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

data/docs/Event.md

@@ -0,0 +1,26 @@
+# PrimaryConnectClient::Event
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional] |
+| **eventable_type** | **String** |  | [optional] |
+| **created_at** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **eventable_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::Event.new(
+  type: null,
+  eventable_type: null,
+  created_at: null,
+  id: null,
+  eventable_id: null
+)
+```
+

data/docs/Events.md

@@ -0,0 +1,18 @@
+# PrimaryConnectClient::Events
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **events** | [**Array<Event>**](Event.md) | List of events (max 25) | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::Events.new(
+  events: null
+)
+```
+

data/docs/Identifier.md

@@ -0,0 +1,20 @@
+# PrimaryConnectClient::Identifier
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **id_type** | **String** | E.g. MRN, EPI, EHRI, NIST, NPI, Payor ID | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::Identifier.new(
+  id: null,
+  id_type: 1234567
+)
+```
+

data/docs/Location.md

@@ -0,0 +1,28 @@
+# PrimaryConnectClient::Location
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | E.g. Clinic, Department, Home, Nursing Unit, Provider's Office, Phone | [optional] |
+| **facility** | **String** |  | [optional] |
+| **department** | **String** |  | [optional] |
+| **room** | **String** |  | [optional] |
+| **bed** | **String** |  | [optional] |
+| **floor** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::Location.new(
+  type: Clinic,
+  facility: Community Hospital,
+  department: null,
+  room: 136,
+  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/Meta.md

@@ -0,0 +1,34 @@
+# PrimaryConnectClient::Meta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_type** | **String** |  | [optional] |
+| **event_date_and_time** | **Time** |  | [optional] |
+| **test** | **Boolean** |  | [optional] |
+| **source** | [**MetaSource**](MetaSource.md) |  | [optional] |
+| **destinations** | [**Array<MetaDestinations>**](MetaDestinations.md) |  | [optional] |
+| **message** | [**MetaMessage**](MetaMessage.md) |  | [optional] |
+| **transmission** | [**MetaTransmission**](MetaTransmission.md) |  | [optional] |
+| **facility_code** | **String** |  | [optional] |
+| **echo** | **Object** | Arbitrary key/value pairs to store with the Order | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::Meta.new(
+  event_type: EVENT_TYPE_NEW,
+  event_date_and_time: 2021-07-30T20:27:55Z,
+  test: true,
+  source: null,
+  destinations: null,
+  message: null,
+  transmission: null,
+  facility_code: 123,
+  echo: null
+)
+```
+

data/docs/MetaDestinations.md

@@ -0,0 +1,22 @@
+# PrimaryConnectClient::MetaDestinations
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | **String** |  | [optional] |
+| **config** | **Object** | Arbitrary key/value pairs for Lab specific use | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::MetaDestinations.new(
+  id: 01FXNPV4TCTGRSV4EGTJMW0D0Y,
+  name: Sample Lab,
+  config: {"key1":"value1","key2":"value2"}
+)
+```
+

data/docs/MetaMessage.md

@@ -0,0 +1,20 @@
+# PrimaryConnectClient::MetaMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **order_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::MetaMessage.new(
+  id: 12345,
+  order_id: null
+)
+```
+

data/docs/MetaSource.md

@@ -0,0 +1,20 @@
+# PrimaryConnectClient::MetaSource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::MetaSource.new(
+  id: 1,
+  name: Primary Connect
+)
+```
+

data/docs/MetaTransmission.md

@@ -0,0 +1,18 @@
+# PrimaryConnectClient::MetaTransmission
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::MetaTransmission.new(
+  id: 12345
+)
+```
+

data/docs/Name.md

@@ -0,0 +1,22 @@
+# PrimaryConnectClient::Name
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **first_name** | **String** |  | [optional] |
+| **last_name** | **String** |  | [optional] |
+| **middle_name** | **String** | middle name or middle initial. For people with multiple middle names, all their middle names are included in this field. | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::Name.new(
+  first_name: George,
+  last_name: Lopez,
+  middle_name: James
+)
+```
+

data/docs/Order.md

@@ -0,0 +1,26 @@
+# PrimaryConnectClient::Order
+
+## Properties
+
+| 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] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::Order.new(
+  patient: null,
+  subject: null,
+  visit: null,
+  meta: null,
+  order: null
+)
+```
+

data/docs/OrderIds.md

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

data/docs/OrderOrder.md

@@ -0,0 +1,62 @@
+# PrimaryConnectClient::OrderOrder
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | ID of the order assigned by the placing system | [optional] |
+| **application_order_id** | **String** | ID assigned by the application fulfilling the order | [optional] |
+| **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] |
+| **ordering_facility** | [**OrderOrderOrderingFacility**](OrderOrderOrderingFacility.md) |  | [optional] |
+| **priority** | **String** | Priority of the order | [optional] |
+| **diagnoses** | [**Array<OrderOrderDiagnoses>**](OrderOrderDiagnoses.md) | List of diagnoses associated with this order | [optional] |
+| **clinical_comments** | **String** | Clinically relevant comments regarding the order | [optional] |
+| **notes** | **Array<String>** | Order-level notes | [optional] |
+| **clinical_info** | [**Array<OrderOrderClinicalInfo>**](OrderOrderClinicalInfo.md) | List of supplementary clinical information associated with the order. Often these are answers to Ask at Order Entry (AOE) questions. | [optional] |
+| **results_status** | **String** | Current overall status of the order | [optional] |
+| **response_flag** | **String** | Specificity of the response requested from the receiving system | [optional] |
+| **external_ids** | [**Array<Identifier>**](Identifier.md) |  | [optional] |
+| **results** | [**Array<Result>**](Result.md) | List of result components | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::OrderOrder.new(
+  id: 12345,
+  application_order_id: 67890,
+  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,
+  ordering_facility: null,
+  priority: null,
+  diagnoses: null,
+  clinical_comments: null,
+  notes: null,
+  clinical_info: null,
+  results_status: null,
+  response_flag: null,
+  external_ids: null,
+  results: null
+)
+```
+

data/docs/OrderOrderClinicalInfo.md

@@ -0,0 +1,26 @@
+# PrimaryConnectClient::OrderOrderClinicalInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | [**CodedValue**](CodedValue.md) |  | [optional] |
+| **value** | **String** | Value of the information element.  For AOEs, this is typically the full answer | [optional] |
+| **units** | **String** | Units of the value.  If the Value is a time range, this may be \"WK\" | [optional] |
+| **abbreviation** | **String** | Abbreviation of the value of the information element.  Typically only present for text answer AOEs | [optional] |
+| **notes** | **Array<String>** | Notes related to the clinical info | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::OrderOrderClinicalInfo.new(
+  code: null,
+  value: Yes,
+  units: null,
+  abbreviation: null,
+  notes: null
+)
+```
+

data/docs/OrderOrderDiagnoses.md

@@ -0,0 +1,22 @@
+# PrimaryConnectClient::OrderOrderDiagnoses
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | [**CodedValue**](CodedValue.md) |  | [optional] |
+| **type** | **String** | Type of the diagnosis | [optional] |
+| **documented_date_time** | **Time** | Timestamp of the the diagnosis was documented | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::OrderOrderDiagnoses.new(
+  code: null,
+  type: null,
+  documented_date_time: null
+)
+```
+

data/docs/OrderOrderOrderingFacility.md

@@ -0,0 +1,22 @@
+# PrimaryConnectClient::OrderOrderOrderingFacility
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **address** | [**Address**](Address.md) |  | [optional] |
+| **phone_numbers** | [**Array<PhoneNumber>**](PhoneNumber.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::OrderOrderOrderingFacility.new(
+  name: Test Facility,
+  address: null,
+  phone_numbers: null
+)
+```
+

data/docs/OrderOrderSpecimen.md

@@ -0,0 +1,22 @@
+# PrimaryConnectClient::OrderOrderSpecimen
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | ID of the collected specimen | [optional] |
+| **source** | **String** | Source of the specimen | [optional] |
+| **body_site** | **String** | Body site from which the specimen was collected | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::OrderOrderSpecimen.new(
+  id: PB124567890,
+  source: nares,
+  body_site: null
+)
+```
+

data/docs/OrderWithEventErrors.md

@@ -0,0 +1,20 @@
+# PrimaryConnectClient::OrderWithEventErrors
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **order** | [**Order**](Order.md) |  | [optional] |
+| **errors** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::OrderWithEventErrors.new(
+  order: null,
+  errors: null
+)
+```
+

data/docs/Orders.md

@@ -0,0 +1,18 @@
+# PrimaryConnectClient::Orders
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **orders** | [**Array<OrdersOrders>**](OrdersOrders.md) | List of orders (max 25) | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::Orders.new(
+  orders: null
+)
+```
+

data/docs/OrdersOrders.md

@@ -0,0 +1,22 @@
+# PrimaryConnectClient::OrdersOrders
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **state** | **String** |  | [optional] |
+| **order** | [**Order**](Order.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::OrdersOrders.new(
+  id: null,
+  state: null,
+  order: null
+)
+```
+

data/docs/Patient.md

@@ -0,0 +1,24 @@
+# PrimaryConnectClient::Patient
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identifiers** | [**Array<Identifier>**](Identifier.md) | List of IDs and types that identify the patient | [optional] |
+| **demographics** | [**Demographics**](Demographics.md) |  | [optional] |
+| **notes** | **Array<String>** | Patient-level notes | [optional] |
+| **contacts** | [**Array<PatientContacts>**](PatientContacts.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::Patient.new(
+  identifiers: null,
+  demographics: null,
+  notes: null,
+  contacts: null
+)
+```
+

data/docs/PatientContacts.md

@@ -0,0 +1,28 @@
+# PrimaryConnectClient::PatientContacts
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | [**Name**](Name.md) |  | [optional] |
+| **address** | [**Address**](Address.md) |  | [optional] |
+| **phone_numbers** | [**Array<PhoneNumber>**](PhoneNumber.md) |  | [optional] |
+| **relation_to_patient** | **String** | Personal relationship to the patient | [optional] |
+| **email_addresses** | **Array<String>** |  | [optional] |
+| **roles** | **Array<String>** | e.g. Employer, Emergency Contact | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::PatientContacts.new(
+  name: null,
+  address: null,
+  phone_numbers: null,
+  relation_to_patient: null,
+  email_addresses: null,
+  roles: null
+)
+```
+