primary_connect_client 0.8.0 → 1.2.0

data/docs/PatientDemographics.md

@@ -0,0 +1,52 @@
+# PrimaryConnectClient::PatientDemographics
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | [**Name**](Name.md) |  | [optional] |
+| **dob** | **String** |  | [optional] |
+| **ssn** | **String** |  | [optional] |
+| **sex** | **String** |  | [optional] |
+| **gender** | **String** |  | [optional] |
+| **sexual_orientation** | **String** |  | [optional] |
+| **races** | **Array<String>** |  | [optional] |
+| **race_details** | **Array<String>** |  | [optional] |
+| **ethnicity** | **String** |  | [optional] |
+| **ethnicity_detail** | **Array<String>** |  | [optional] |
+| **marital_status** | **String** |  | [optional] |
+| **is_deceased** | **Boolean** |  | [optional] |
+| **death_date_time** | **Time** | ISO 8601 | [optional] |
+| **phone_numbers** | [**Array<PhoneNumber>**](PhoneNumber.md) |  | [optional] |
+| **email_addresses** | **Array<String>** |  | [optional] |
+| **language_code** | **String** |  | [optional] |
+| **citizenships** | **Array<String>** |  | [optional] |
+| **address** | [**Address**](Address.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::PatientDemographics.new(
+  name: null,
+  dob: 1992-07-23,
+  ssn: null,
+  sex: null,
+  gender: null,
+  sexual_orientation: null,
+  races: null,
+  race_details: null,
+  ethnicity: null,
+  ethnicity_detail: null,
+  marital_status: null,
+  is_deceased: null,
+  death_date_time: null,
+  phone_numbers: null,
+  email_addresses: null,
+  language_code: en,
+  citizenships: null,
+  address: null
+)
+```
+

data/docs/PhoneNumber.md

@@ -0,0 +1,20 @@
+# PrimaryConnectClient::PhoneNumber
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional] |
+| **number** | **String** | E.164 | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::PhoneNumber.new(
+  type: null,
+  number: +15555555555
+)
+```
+

data/docs/Provider.md

@@ -0,0 +1,32 @@
+# PrimaryConnectClient::Provider
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identifier** | [**Identifier**](Identifier.md) |  | [optional] |
+| **npi** | **String** |  | [optional] |
+| **name** | [**Name**](Name.md) |  | [optional] |
+| **credentials** | **Array<String>** | List of credentials for the provider.  e.g. MD, PhD | [optional] |
+| **address** | [**Address**](Address.md) |  | [optional] |
+| **email_addresses** | **Array<String>** |  | [optional] |
+| **phone_numbers** | [**Array<PhoneNumber>**](PhoneNumber.md) |  | [optional] |
+| **location** | [**Location**](Location.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::Provider.new(
+  identifier: null,
+  npi: 1234567890,
+  name: null,
+  credentials: null,
+  address: null,
+  email_addresses: null,
+  phone_numbers: null,
+  location: null
+)
+```
+

data/docs/Result.md

@@ -0,0 +1,52 @@
+# PrimaryConnectClient::Result
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | [**CodedValue**](CodedValue.md) |  | [optional] |
+| **related_group_id** | **Array<String>** | ID to group separate result components | [optional] |
+| **specimen** | [**Specimen**](Specimen.md) |  | [optional] |
+| **value** | **String** | Value of the result component | [optional] |
+| **value_type** | **String** | Data type for the result value | [optional] |
+| **completion_date_time** | **Time** | Timestamp when the results were composed into a report and released. | [optional] |
+| **report** | [**ResultReport**](ResultReport.md) |  | [optional] |
+| **units** | **String** | Units of the result | [optional] |
+| **notes** | **Array<String>** | Notes about the result component/observation | [optional] |
+| **abnormal_flag** | **String** | Indication of whether the result was abnormal | [optional] |
+| **status** | **String** | Current status of the result | [optional] |
+| **primary_results_interpreter** | [**Provider**](Provider.md) |  | [optional] |
+| **producer** | **Object** |  | [optional] |
+| **performer** | [**Provider**](Provider.md) |  | [optional] |
+| **reference_range** | [**ResultReferenceRange**](ResultReferenceRange.md) |  | [optional] |
+| **observation_method** | [**CodedValue**](CodedValue.md) |  | [optional] |
+| **producer_order_id** | **String** | Unique ID generated by resulting entity | [optional] |
+| **finding_value** | [**CodedValue**](CodedValue.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::Result.new(
+  code: null,
+  related_group_id: null,
+  specimen: null,
+  value: negative,
+  value_type: STRING,
+  completion_date_time: 2021-07-10T12:35:45-07:00,
+  report: null,
+  units: null,
+  notes: null,
+  abnormal_flag: null,
+  status: null,
+  primary_results_interpreter: null,
+  producer: null,
+  performer: null,
+  reference_range: null,
+  observation_method: null,
+  producer_order_id: 12345678,
+  finding_value: null
+)
+```
+

data/docs/ResultIds.md

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

data/docs/ResultReferenceRange.md

@@ -0,0 +1,22 @@
+# PrimaryConnectClient::ResultReferenceRange
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **low** | **Integer** | Lower bound for a normal result | [optional] |
+| **high** | **Integer** | Upper bound for a normal result | [optional] |
+| **text** | **String** | Normal value for non-numeric results | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::ResultReferenceRange.new(
+  low: null,
+  high: null,
+  text: null
+)
+```
+

data/docs/ResultReport.md

@@ -0,0 +1,22 @@
+# PrimaryConnectClient::ResultReport
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_type** | **String** | Report MIME type | [optional] |
+| **data** | **String** | Base64 encoded report | [optional] |
+| **url** | **String** | Report URL redirect | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::ResultReport.new(
+  file_type: application/pdf,
+  data: <BASE64 ENCODED PDF>,
+  url: https://example.com/report?12345
+)
+```
+

data/docs/ResultSpecimen.md

@@ -0,0 +1,22 @@
+# PrimaryConnectClient::ResultSpecimen
+
+## 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::ResultSpecimen.new(
+  id: PB123456789,
+  source: nasal,
+  body_site: null
+)
+```
+

data/docs/Results.md

@@ -0,0 +1,20 @@
+# PrimaryConnectClient::Results
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **meta** | [**Meta**](Meta.md) |  | [optional] |
+| **results** | [**Array<Result>**](Result.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::Results.new(
+  meta: null,
+  results: null
+)
+```
+

data/docs/Specimen.md

@@ -0,0 +1,22 @@
+# PrimaryConnectClient::Specimen
+
+## 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::Specimen.new(
+  id: PB124567890,
+  source: nares,
+  body_site: 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/docs/Visit.md

@@ -0,0 +1,36 @@
+# PrimaryConnectClient::Visit
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **visit_number** | **String** | Unique ID of a single visit | [optional] |
+| **account_number** | **String** | An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc. | [optional] |
+| **patient_class** | **String** | Patient class is used in many EHRs to determine where to put the patient. E.g. Inpatient, Outpatient, Emergency | [optional] |
+| **visit_date_time** | **Time** | Timestamp of visit or the arrival time of the visit or admission. | [optional] |
+| **attending_provider** | [**Provider**](Provider.md) |  | [optional] |
+| **consulting_provider** | [**Provider**](Provider.md) |  | [optional] |
+| **referring_provider** | [**Provider**](Provider.md) |  | [optional] |
+| **guarantor** | [**VisitGuarantor**](VisitGuarantor.md) |  | [optional] |
+| **insurances** | [**Array<VisitInsurances>**](VisitInsurances.md) | List of insurance coverages for the patient | [optional] |
+| **location** | [**Location**](Location.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::Visit.new(
+  visit_number: 12345,
+  account_number: null,
+  patient_class: null,
+  visit_date_time: 2021-07-10T12:20:11-07:00,
+  attending_provider: null,
+  consulting_provider: null,
+  referring_provider: null,
+  guarantor: null,
+  insurances: null,
+  location: null
+)
+```
+

data/docs/VisitCompany.md

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

data/docs/VisitGuarantor.md

@@ -0,0 +1,40 @@
+# PrimaryConnectClient::VisitGuarantor
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **number** | **String** | Number of the guarantor (?) | [optional] |
+| **name** | [**Name**](Name.md) |  | [optional] |
+| **ssn** | **String** |  | [optional] |
+| **dob** | **String** | Date of Birth | [optional] |
+| **sex** | **String** |  | [optional] |
+| **spouse** | [**Name**](Name.md) |  | [optional] |
+| **address** | [**Address**](Address.md) |  | [optional] |
+| **phone_numbers** | [**Array<PhoneNumber>**](PhoneNumber.md) |  | [optional] |
+| **email_addresses** | **Array<String>** |  | [optional] |
+| **type** | **String** |  | [optional] |
+| **relation_to_patient** | **String** |  | [optional] |
+| **employer** | [**VisitGuarantorEmployer**](VisitGuarantorEmployer.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::VisitGuarantor.new(
+  number: null,
+  name: null,
+  ssn: null,
+  dob: 1952-09-03,
+  sex: null,
+  spouse: null,
+  address: null,
+  phone_numbers: null,
+  email_addresses: null,
+  type: null,
+  relation_to_patient: null,
+  employer: null
+)
+```
+

data/docs/VisitGuarantorEmployer.md

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

data/docs/VisitInsurances.md

@@ -0,0 +1,40 @@
+# PrimaryConnectClient::VisitInsurances
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **plan** | [**VisitPlan**](VisitPlan.md) |  | [optional] |
+| **member_number** | **Array<String>** | Patient member number | [optional] |
+| **company** | [**VisitCompany**](VisitCompany.md) |  | [optional] |
+| **group_number** | **String** | Insurance policy group number | [optional] |
+| **group_name** | **String** | Insurance policy group name | [optional] |
+| **effective_date** | **String** | YYYY-MM-DD, Effect date of this insurance policy | [optional] |
+| **expiration_date** | **String** | YYYY-MM-DD, Expiration date of this insurance policy | [optional] |
+| **policy_number** | **String** | Insurance policy number | [optional] |
+| **priority** | **String** | The insurance priority sequence | [optional] |
+| **agreement_type** | **String** | Type of insurance agreement | [optional] |
+| **coverage_type** | **String** | Type of insurance Agreement | [optional] |
+| **insured** | [**VisitInsured**](VisitInsured.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::VisitInsurances.new(
+  plan: null,
+  member_number: null,
+  company: null,
+  group_number: 123456789,
+  group_name: null,
+  effective_date: 2021-01-01,
+  expiration_date: 2050-01-01,
+  policy_number: 987654321,
+  priority: null,
+  agreement_type: null,
+  coverage_type: null,
+  insured: null
+)
+```
+