primary_connect_client 0.7.0 → 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +19 -0
- data/README.md +61 -16
- data/docs/Address.md +32 -0
- data/docs/CodedValue.md +22 -0
- data/docs/DefaultApi.md +568 -0
- data/docs/Demographics.md +52 -0
- data/docs/Error.md +18 -0
- data/docs/Event.md +26 -0
- data/docs/Events.md +18 -0
- data/docs/Identifier.md +20 -0
- data/docs/Location.md +26 -0
- data/docs/Meta.md +34 -0
- data/docs/MetaDestinations.md +22 -0
- data/docs/MetaMessage.md +20 -0
- data/docs/MetaSource.md +20 -0
- data/docs/MetaTransmission.md +18 -0
- data/docs/Name.md +22 -0
- data/docs/Order.md +24 -0
- data/docs/OrderIds.md +18 -0
- data/docs/OrderOrder.md +58 -0
- data/docs/OrderOrderClinicalInfo.md +26 -0
- data/docs/OrderOrderDiagnoses.md +22 -0
- data/docs/OrderOrderOrderingFacility.md +22 -0
- data/docs/OrderOrderSpecimen.md +22 -0
- data/docs/OrderWithEventErrors.md +20 -0
- data/docs/Orders.md +18 -0
- data/docs/OrdersOrders.md +22 -0
- data/docs/Patient.md +24 -0
- data/docs/PatientContacts.md +28 -0
- data/docs/PatientDemographics.md +52 -0
- data/docs/PhoneNumber.md +20 -0
- data/docs/Provider.md +32 -0
- data/docs/Result.md +52 -0
- data/docs/ResultIds.md +18 -0
- data/docs/ResultReferenceRange.md +22 -0
- data/docs/ResultReport.md +22 -0
- data/docs/ResultSpecimen.md +22 -0
- data/docs/Results.md +20 -0
- data/docs/Specimen.md +22 -0
- data/docs/Visit.md +36 -0
- data/docs/VisitCompany.md +24 -0
- data/docs/VisitGuarantor.md +40 -0
- data/docs/VisitGuarantorEmployer.md +22 -0
- data/docs/VisitInsurances.md +40 -0
- data/docs/VisitInsured.md +30 -0
- data/docs/VisitPlan.md +22 -0
- data/git_push.sh +5 -6
- data/lib/primary_connect_client/api/default_api.rb +143 -66
- data/lib/primary_connect_client/api_client.rb +5 -6
- data/lib/primary_connect_client/api_error.rb +1 -1
- data/lib/primary_connect_client/configuration.rb +4 -3
- data/lib/primary_connect_client/models/address.rb +281 -0
- data/lib/primary_connect_client/models/coded_value.rb +238 -0
- data/lib/primary_connect_client/models/demographics.rb +466 -0
- data/lib/primary_connect_client/models/error.rb +218 -0
- data/lib/primary_connect_client/models/event.rb +254 -0
- data/lib/primary_connect_client/models/events.rb +221 -0
- data/lib/primary_connect_client/models/identifier.rb +228 -0
- data/lib/primary_connect_client/models/location.rb +255 -0
- data/lib/primary_connect_client/models/meta.rb +327 -0
- data/lib/primary_connect_client/models/meta_destinations.rb +242 -0
- data/lib/primary_connect_client/models/meta_message.rb +227 -0
- data/lib/primary_connect_client/models/meta_source.rb +227 -0
- data/lib/primary_connect_client/models/meta_transmission.rb +218 -0
- data/lib/primary_connect_client/models/name.rb +237 -0
- data/lib/primary_connect_client/models/order.rb +245 -0
- data/lib/primary_connect_client/models/order_ids.rb +221 -0
- data/lib/primary_connect_client/models/order_order.rb +496 -0
- data/lib/primary_connect_client/models/order_order_clinical_info.rb +260 -0
- data/lib/primary_connect_client/models/order_order_diagnoses.rb +272 -0
- data/lib/primary_connect_client/models/order_order_ordering_facility.rb +239 -0
- data/lib/primary_connect_client/models/order_order_specimen.rb +239 -0
- data/lib/primary_connect_client/models/order_with_event_errors.rb +229 -0
- data/lib/primary_connect_client/models/orders.rb +221 -0
- data/lib/primary_connect_client/models/orders_orders.rb +236 -0
- data/lib/primary_connect_client/models/patient.rb +253 -0
- data/lib/primary_connect_client/models/patient_contacts.rb +305 -0
- data/lib/primary_connect_client/models/patient_demographics.rb +466 -0
- data/lib/primary_connect_client/models/phone_number.rb +262 -0
- data/lib/primary_connect_client/models/provider.rb +288 -0
- data/lib/primary_connect_client/models/result.rb +443 -0
- data/lib/primary_connect_client/models/result_ids.rb +221 -0
- data/lib/primary_connect_client/models/result_reference_range.rb +240 -0
- data/lib/primary_connect_client/models/result_report.rb +240 -0
- data/lib/primary_connect_client/models/result_specimen.rb +239 -0
- data/lib/primary_connect_client/models/results.rb +230 -0
- data/lib/primary_connect_client/models/specimen.rb +239 -0
- data/lib/primary_connect_client/models/visit.rb +306 -0
- data/lib/primary_connect_client/models/visit_company.rb +248 -0
- data/lib/primary_connect_client/models/visit_guarantor.rb +358 -0
- data/lib/primary_connect_client/models/visit_guarantor_employer.rb +238 -0
- data/lib/primary_connect_client/models/visit_insurances.rb +386 -0
- data/lib/primary_connect_client/models/visit_insured.rb +322 -0
- data/lib/primary_connect_client/models/visit_plan.rb +238 -0
- data/lib/primary_connect_client/version.rb +12 -2
- data/lib/primary_connect_client.rb +45 -3
- data/primary_connect_client.gemspec +7 -5
- data/spec/api/default_api_spec.rb +44 -41
- data/spec/api_client_spec.rb +3 -3
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/address_spec.rb +76 -0
- data/spec/models/coded_value_spec.rb +46 -0
- data/spec/models/demographics_spec.rb +168 -0
- data/spec/models/error_spec.rb +34 -0
- data/spec/models/event_spec.rb +58 -0
- data/spec/models/events_spec.rb +34 -0
- data/spec/models/identifier_spec.rb +40 -0
- data/spec/models/location_spec.rb +58 -0
- data/spec/models/meta_destinations_spec.rb +46 -0
- data/spec/models/meta_message_spec.rb +40 -0
- data/spec/models/meta_source_spec.rb +40 -0
- data/spec/models/meta_spec.rb +86 -0
- data/spec/models/meta_transmission_spec.rb +34 -0
- data/spec/models/name_spec.rb +46 -0
- data/spec/models/order_ids_spec.rb +34 -0
- data/spec/models/order_order_clinical_info_spec.rb +58 -0
- data/spec/models/order_order_diagnoses_spec.rb +50 -0
- data/spec/models/order_order_ordering_facility_spec.rb +46 -0
- data/spec/models/order_order_spec.rb +170 -0
- data/spec/models/order_order_specimen_spec.rb +46 -0
- data/spec/models/order_spec.rb +52 -0
- data/spec/models/order_with_event_errors_spec.rb +40 -0
- data/spec/models/orders_orders_spec.rb +46 -0
- data/spec/models/orders_spec.rb +34 -0
- data/spec/models/patient_contacts_spec.rb +68 -0
- data/spec/models/patient_demographics_spec.rb +168 -0
- data/spec/models/patient_spec.rb +52 -0
- data/spec/models/phone_number_spec.rb +44 -0
- data/spec/models/provider_spec.rb +76 -0
- data/spec/models/result_ids_spec.rb +34 -0
- data/spec/models/result_reference_range_spec.rb +46 -0
- data/spec/models/result_report_spec.rb +46 -0
- data/spec/models/result_spec.rb +148 -0
- data/spec/models/result_specimen_spec.rb +46 -0
- data/spec/models/results_spec.rb +40 -0
- data/spec/models/specimen_spec.rb +46 -0
- data/spec/models/visit_company_spec.rb +52 -0
- data/spec/models/visit_guarantor_employer_spec.rb +46 -0
- data/spec/models/visit_guarantor_spec.rb +104 -0
- data/spec/models/visit_insurances_spec.rb +112 -0
- data/spec/models/visit_insured_spec.rb +78 -0
- data/spec/models/visit_plan_spec.rb +46 -0
- data/spec/models/visit_spec.rb +88 -0
- data/spec/spec_helper.rb +1 -1
- metadata +177 -20
- data/Gemfile.lock +0 -74
data/docs/Location.md
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
# PrimaryConnectClient::Location
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **type** | **String** | E.g. Clinic, Department, Home, Nursing Unit, Provider's Office, Phone | [optional] |
|
8
|
+
| **facility** | **String** | | [optional] |
|
9
|
+
| **department** | **String** | | [optional] |
|
10
|
+
| **room** | **String** | | [optional] |
|
11
|
+
| **bed** | **String** | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'primary_connect_client'
|
17
|
+
|
18
|
+
instance = PrimaryConnectClient::Location.new(
|
19
|
+
type: Clinic,
|
20
|
+
facility: Community Hospital,
|
21
|
+
department: null,
|
22
|
+
room: 136,
|
23
|
+
bed: B
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
data/docs/Meta.md
ADDED
@@ -0,0 +1,34 @@
|
|
1
|
+
# PrimaryConnectClient::Meta
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **event_type** | **String** | | [optional] |
|
8
|
+
| **event_date_and_time** | **Time** | | [optional] |
|
9
|
+
| **test** | **Boolean** | | [optional] |
|
10
|
+
| **source** | [**MetaSource**](MetaSource.md) | | [optional] |
|
11
|
+
| **destinations** | [**Array<MetaDestinations>**](MetaDestinations.md) | | [optional] |
|
12
|
+
| **message** | [**MetaMessage**](MetaMessage.md) | | [optional] |
|
13
|
+
| **transmission** | [**MetaTransmission**](MetaTransmission.md) | | [optional] |
|
14
|
+
| **facility_code** | **String** | | [optional] |
|
15
|
+
| **echo** | **Object** | Arbitrary key/value pairs to store with the Order | [optional] |
|
16
|
+
|
17
|
+
## Example
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'primary_connect_client'
|
21
|
+
|
22
|
+
instance = PrimaryConnectClient::Meta.new(
|
23
|
+
event_type: EVENT_TYPE_NEW,
|
24
|
+
event_date_and_time: 2021-07-30T20:27:55Z,
|
25
|
+
test: true,
|
26
|
+
source: null,
|
27
|
+
destinations: null,
|
28
|
+
message: null,
|
29
|
+
transmission: null,
|
30
|
+
facility_code: 123,
|
31
|
+
echo: null
|
32
|
+
)
|
33
|
+
```
|
34
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# PrimaryConnectClient::MetaDestinations
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | | |
|
8
|
+
| **name** | **String** | | [optional] |
|
9
|
+
| **config** | **Object** | Arbitrary key/value pairs for Lab specific use | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'primary_connect_client'
|
15
|
+
|
16
|
+
instance = PrimaryConnectClient::MetaDestinations.new(
|
17
|
+
id: 01FXNPV4TCTGRSV4EGTJMW0D0Y,
|
18
|
+
name: Sample Lab,
|
19
|
+
config: {"key1":"value1","key2":"value2"}
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/MetaMessage.md
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
# PrimaryConnectClient::MetaMessage
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | | [optional] |
|
8
|
+
| **order_id** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'primary_connect_client'
|
14
|
+
|
15
|
+
instance = PrimaryConnectClient::MetaMessage.new(
|
16
|
+
id: 12345,
|
17
|
+
order_id: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/MetaSource.md
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
# PrimaryConnectClient::MetaSource
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | | [optional] |
|
8
|
+
| **name** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'primary_connect_client'
|
14
|
+
|
15
|
+
instance = PrimaryConnectClient::MetaSource.new(
|
16
|
+
id: 1,
|
17
|
+
name: Primary Connect
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# PrimaryConnectClient::MetaTransmission
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'primary_connect_client'
|
13
|
+
|
14
|
+
instance = PrimaryConnectClient::MetaTransmission.new(
|
15
|
+
id: 12345
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
data/docs/Name.md
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
# PrimaryConnectClient::Name
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **first_name** | **String** | | [optional] |
|
8
|
+
| **last_name** | **String** | | [optional] |
|
9
|
+
| **middle_name** | **String** | middle name or middle initial. For people with multiple middle names, all their middle names are included in this field. | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'primary_connect_client'
|
15
|
+
|
16
|
+
instance = PrimaryConnectClient::Name.new(
|
17
|
+
first_name: George,
|
18
|
+
last_name: Lopez,
|
19
|
+
middle_name: James
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/Order.md
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# PrimaryConnectClient::Order
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **patient** | [**Patient**](Patient.md) | | [optional] |
|
8
|
+
| **visit** | [**Visit**](Visit.md) | | [optional] |
|
9
|
+
| **meta** | [**Meta**](Meta.md) | | [optional] |
|
10
|
+
| **order** | [**OrderOrder**](OrderOrder.md) | | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'primary_connect_client'
|
16
|
+
|
17
|
+
instance = PrimaryConnectClient::Order.new(
|
18
|
+
patient: null,
|
19
|
+
visit: null,
|
20
|
+
meta: null,
|
21
|
+
order: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/OrderIds.md
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# PrimaryConnectClient::OrderIds
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **orders** | **Array<String>** | List of Order IDs | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'primary_connect_client'
|
13
|
+
|
14
|
+
instance = PrimaryConnectClient::OrderIds.new(
|
15
|
+
orders: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
data/docs/OrderOrder.md
ADDED
@@ -0,0 +1,58 @@
|
|
1
|
+
# PrimaryConnectClient::OrderOrder
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | ID of the order assigned by the placing system | [optional] |
|
8
|
+
| **application_order_id** | **String** | ID assigned by the application fulfilling the order | [optional] |
|
9
|
+
| **status** | **String** | The status of an order. | [optional] |
|
10
|
+
| **transaction_date_time** | **Time** | Timestamp when the order was placed | [optional] |
|
11
|
+
| **collection_date_time** | **Time** | Timestamp when the specimen was collected | [optional] |
|
12
|
+
| **completion_date_time** | **Time** | Timestamp when the results were composed into a report and released. | [optional] |
|
13
|
+
| **expiration_date** | **String** | YYYY-MM-DD, Date when the order becomes invalid | [optional] |
|
14
|
+
| **specimen** | [**Specimen**](Specimen.md) | | [optional] |
|
15
|
+
| **procedure** | [**CodedValue**](CodedValue.md) | | [optional] |
|
16
|
+
| **ordering_provider** | [**Provider**](Provider.md) | | [optional] |
|
17
|
+
| **result_copy_providers** | [**Array<Provider>**](Provider.md) | Array of providers to be copied on the results | [optional] |
|
18
|
+
| **ordering_facility** | [**OrderOrderOrderingFacility**](OrderOrderOrderingFacility.md) | | [optional] |
|
19
|
+
| **priority** | **String** | Priority of the order | [optional] |
|
20
|
+
| **diagnoses** | [**Array<OrderOrderDiagnoses>**](OrderOrderDiagnoses.md) | List of diagnoses associated with this order | [optional] |
|
21
|
+
| **clinical_comments** | **String** | Clinically relevant comments regarding the order | [optional] |
|
22
|
+
| **notes** | **Array<String>** | Order-level notes | [optional] |
|
23
|
+
| **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] |
|
24
|
+
| **results_status** | **String** | Current overall status of the order | [optional] |
|
25
|
+
| **response_flag** | **String** | Specificity of the response requested from the receiving system | [optional] |
|
26
|
+
| **external_ids** | [**Array<Identifier>**](Identifier.md) | | [optional] |
|
27
|
+
| **results** | [**Array<Result>**](Result.md) | List of result components | [optional] |
|
28
|
+
|
29
|
+
## Example
|
30
|
+
|
31
|
+
```ruby
|
32
|
+
require 'primary_connect_client'
|
33
|
+
|
34
|
+
instance = PrimaryConnectClient::OrderOrder.new(
|
35
|
+
id: 12345,
|
36
|
+
application_order_id: 67890,
|
37
|
+
status: null,
|
38
|
+
transaction_date_time: 2021-07-10T12:35:45-07:00,
|
39
|
+
collection_date_time: 2021-07-10T12:35:45-07:00,
|
40
|
+
completion_date_time: 2021-07-10T12:35:45-07:00,
|
41
|
+
expiration_date: 2022-05-23,
|
42
|
+
specimen: null,
|
43
|
+
procedure: null,
|
44
|
+
ordering_provider: null,
|
45
|
+
result_copy_providers: null,
|
46
|
+
ordering_facility: null,
|
47
|
+
priority: null,
|
48
|
+
diagnoses: null,
|
49
|
+
clinical_comments: null,
|
50
|
+
notes: null,
|
51
|
+
clinical_info: null,
|
52
|
+
results_status: null,
|
53
|
+
response_flag: null,
|
54
|
+
external_ids: null,
|
55
|
+
results: null
|
56
|
+
)
|
57
|
+
```
|
58
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# PrimaryConnectClient::OrderOrderClinicalInfo
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **code** | [**CodedValue**](CodedValue.md) | | [optional] |
|
8
|
+
| **value** | **String** | Value of the information element. For AOEs, this is typically the full answer | [optional] |
|
9
|
+
| **units** | **String** | Units of the value. If the Value is a time range, this may be \"WK\" | [optional] |
|
10
|
+
| **abbreviation** | **String** | Abbreviation of the value of the information element. Typically only present for text answer AOEs | [optional] |
|
11
|
+
| **notes** | **Array<String>** | Notes related to the clinical info | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'primary_connect_client'
|
17
|
+
|
18
|
+
instance = PrimaryConnectClient::OrderOrderClinicalInfo.new(
|
19
|
+
code: null,
|
20
|
+
value: Yes,
|
21
|
+
units: null,
|
22
|
+
abbreviation: null,
|
23
|
+
notes: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# PrimaryConnectClient::OrderOrderDiagnoses
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **code** | [**CodedValue**](CodedValue.md) | | [optional] |
|
8
|
+
| **type** | **String** | Type of the diagnosis | [optional] |
|
9
|
+
| **documented_date_time** | **Time** | Timestamp of the the diagnosis was documented | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'primary_connect_client'
|
15
|
+
|
16
|
+
instance = PrimaryConnectClient::OrderOrderDiagnoses.new(
|
17
|
+
code: null,
|
18
|
+
type: null,
|
19
|
+
documented_date_time: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# PrimaryConnectClient::OrderOrderOrderingFacility
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | | [optional] |
|
8
|
+
| **address** | [**Address**](Address.md) | | [optional] |
|
9
|
+
| **phone_numbers** | [**Array<PhoneNumber>**](PhoneNumber.md) | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'primary_connect_client'
|
15
|
+
|
16
|
+
instance = PrimaryConnectClient::OrderOrderOrderingFacility.new(
|
17
|
+
name: Test Facility,
|
18
|
+
address: null,
|
19
|
+
phone_numbers: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# PrimaryConnectClient::OrderOrderSpecimen
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | ID of the collected specimen | [optional] |
|
8
|
+
| **source** | **String** | Source of the specimen | [optional] |
|
9
|
+
| **body_site** | **String** | Body site from which the specimen was collected | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'primary_connect_client'
|
15
|
+
|
16
|
+
instance = PrimaryConnectClient::OrderOrderSpecimen.new(
|
17
|
+
id: PB124567890,
|
18
|
+
source: nares,
|
19
|
+
body_site: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# PrimaryConnectClient::OrderWithEventErrors
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **order** | [**Order**](Order.md) | | [optional] |
|
8
|
+
| **errors** | **Array<String>** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'primary_connect_client'
|
14
|
+
|
15
|
+
instance = PrimaryConnectClient::OrderWithEventErrors.new(
|
16
|
+
order: null,
|
17
|
+
errors: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/Orders.md
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# PrimaryConnectClient::Orders
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **orders** | [**Array<OrdersOrders>**](OrdersOrders.md) | List of orders (max 25) | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'primary_connect_client'
|
13
|
+
|
14
|
+
instance = PrimaryConnectClient::Orders.new(
|
15
|
+
orders: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# PrimaryConnectClient::OrdersOrders
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | | [optional] |
|
8
|
+
| **state** | **String** | | [optional] |
|
9
|
+
| **order** | [**Order**](Order.md) | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'primary_connect_client'
|
15
|
+
|
16
|
+
instance = PrimaryConnectClient::OrdersOrders.new(
|
17
|
+
id: null,
|
18
|
+
state: null,
|
19
|
+
order: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/Patient.md
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# PrimaryConnectClient::Patient
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **identifiers** | [**Array<Identifier>**](Identifier.md) | List of IDs and types that identify the patient | [optional] |
|
8
|
+
| **demographics** | [**Demographics**](Demographics.md) | | [optional] |
|
9
|
+
| **notes** | **Array<String>** | Patient-level notes | [optional] |
|
10
|
+
| **contacts** | [**Array<PatientContacts>**](PatientContacts.md) | | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'primary_connect_client'
|
16
|
+
|
17
|
+
instance = PrimaryConnectClient::Patient.new(
|
18
|
+
identifiers: null,
|
19
|
+
demographics: null,
|
20
|
+
notes: null,
|
21
|
+
contacts: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# PrimaryConnectClient::PatientContacts
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | [**Name**](Name.md) | | [optional] |
|
8
|
+
| **address** | [**Address**](Address.md) | | [optional] |
|
9
|
+
| **phone_numbers** | [**Array<PhoneNumber>**](PhoneNumber.md) | | [optional] |
|
10
|
+
| **relation_to_patient** | **String** | Personal relationship to the patient | [optional] |
|
11
|
+
| **email_addresses** | **Array<String>** | | [optional] |
|
12
|
+
| **roles** | **Array<String>** | e.g. Employer, Emergency Contact | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'primary_connect_client'
|
18
|
+
|
19
|
+
instance = PrimaryConnectClient::PatientContacts.new(
|
20
|
+
name: null,
|
21
|
+
address: null,
|
22
|
+
phone_numbers: null,
|
23
|
+
relation_to_patient: null,
|
24
|
+
email_addresses: null,
|
25
|
+
roles: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
@@ -0,0 +1,52 @@
|
|
1
|
+
# PrimaryConnectClient::PatientDemographics
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | [**Name**](Name.md) | | [optional] |
|
8
|
+
| **dob** | **String** | | [optional] |
|
9
|
+
| **ssn** | **String** | | [optional] |
|
10
|
+
| **sex** | **String** | | [optional] |
|
11
|
+
| **gender** | **String** | | [optional] |
|
12
|
+
| **sexual_orientation** | **String** | | [optional] |
|
13
|
+
| **races** | **Array<String>** | | [optional] |
|
14
|
+
| **race_details** | **Array<String>** | | [optional] |
|
15
|
+
| **ethnicity** | **String** | | [optional] |
|
16
|
+
| **ethnicity_detail** | **Array<String>** | | [optional] |
|
17
|
+
| **marital_status** | **String** | | [optional] |
|
18
|
+
| **is_deceased** | **Boolean** | | [optional] |
|
19
|
+
| **death_date_time** | **Time** | ISO 8601 | [optional] |
|
20
|
+
| **phone_numbers** | [**Array<PhoneNumber>**](PhoneNumber.md) | | [optional] |
|
21
|
+
| **email_addresses** | **Array<String>** | | [optional] |
|
22
|
+
| **language_code** | **String** | | [optional] |
|
23
|
+
| **citizenships** | **Array<String>** | | [optional] |
|
24
|
+
| **address** | [**Address**](Address.md) | | [optional] |
|
25
|
+
|
26
|
+
## Example
|
27
|
+
|
28
|
+
```ruby
|
29
|
+
require 'primary_connect_client'
|
30
|
+
|
31
|
+
instance = PrimaryConnectClient::PatientDemographics.new(
|
32
|
+
name: null,
|
33
|
+
dob: 1992-07-23,
|
34
|
+
ssn: null,
|
35
|
+
sex: null,
|
36
|
+
gender: null,
|
37
|
+
sexual_orientation: null,
|
38
|
+
races: null,
|
39
|
+
race_details: null,
|
40
|
+
ethnicity: null,
|
41
|
+
ethnicity_detail: null,
|
42
|
+
marital_status: null,
|
43
|
+
is_deceased: null,
|
44
|
+
death_date_time: null,
|
45
|
+
phone_numbers: null,
|
46
|
+
email_addresses: null,
|
47
|
+
language_code: en,
|
48
|
+
citizenships: null,
|
49
|
+
address: null
|
50
|
+
)
|
51
|
+
```
|
52
|
+
|
data/docs/PhoneNumber.md
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
# PrimaryConnectClient::PhoneNumber
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **type** | **String** | | [optional] |
|
8
|
+
| **number** | **String** | E.164 | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'primary_connect_client'
|
14
|
+
|
15
|
+
instance = PrimaryConnectClient::PhoneNumber.new(
|
16
|
+
type: null,
|
17
|
+
number: +15555555555
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/Provider.md
ADDED
@@ -0,0 +1,32 @@
|
|
1
|
+
# PrimaryConnectClient::Provider
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **identifier** | [**Identifier**](Identifier.md) | | [optional] |
|
8
|
+
| **npi** | **String** | | [optional] |
|
9
|
+
| **name** | [**Name**](Name.md) | | [optional] |
|
10
|
+
| **credentials** | **Array<String>** | List of credentials for the provider. e.g. MD, PhD | [optional] |
|
11
|
+
| **address** | [**Address**](Address.md) | | [optional] |
|
12
|
+
| **email_addresses** | **Array<String>** | | [optional] |
|
13
|
+
| **phone_numbers** | [**Array<PhoneNumber>**](PhoneNumber.md) | | [optional] |
|
14
|
+
| **location** | [**Location**](Location.md) | | [optional] |
|
15
|
+
|
16
|
+
## Example
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'primary_connect_client'
|
20
|
+
|
21
|
+
instance = PrimaryConnectClient::Provider.new(
|
22
|
+
identifier: null,
|
23
|
+
npi: 1234567890,
|
24
|
+
name: null,
|
25
|
+
credentials: null,
|
26
|
+
address: null,
|
27
|
+
email_addresses: null,
|
28
|
+
phone_numbers: null,
|
29
|
+
location: null
|
30
|
+
)
|
31
|
+
```
|
32
|
+
|
data/docs/Result.md
ADDED
@@ -0,0 +1,52 @@
|
|
1
|
+
# PrimaryConnectClient::Result
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **code** | [**CodedValue**](CodedValue.md) | | [optional] |
|
8
|
+
| **related_group_id** | **Array<String>** | ID to group separate result components | [optional] |
|
9
|
+
| **specimen** | [**Specimen**](Specimen.md) | | [optional] |
|
10
|
+
| **value** | **String** | Value of the result component | [optional] |
|
11
|
+
| **value_type** | **String** | Data type for the result value | [optional] |
|
12
|
+
| **completion_date_time** | **Time** | Timestamp when the results were composed into a report and released. | [optional] |
|
13
|
+
| **report** | [**ResultReport**](ResultReport.md) | | [optional] |
|
14
|
+
| **units** | **String** | Units of the result | [optional] |
|
15
|
+
| **notes** | **Array<String>** | Notes about the result component/observation | [optional] |
|
16
|
+
| **abnormal_flag** | **String** | Indication of whether the result was abnormal | [optional] |
|
17
|
+
| **status** | **String** | Current status of the result | [optional] |
|
18
|
+
| **primary_results_interpreter** | [**Provider**](Provider.md) | | [optional] |
|
19
|
+
| **producer** | **Object** | | [optional] |
|
20
|
+
| **performer** | [**Provider**](Provider.md) | | [optional] |
|
21
|
+
| **reference_range** | [**ResultReferenceRange**](ResultReferenceRange.md) | | [optional] |
|
22
|
+
| **observation_method** | [**CodedValue**](CodedValue.md) | | [optional] |
|
23
|
+
| **producer_order_id** | **String** | Unique ID generated by resulting entity | [optional] |
|
24
|
+
| **finding_value** | [**CodedValue**](CodedValue.md) | | [optional] |
|
25
|
+
|
26
|
+
## Example
|
27
|
+
|
28
|
+
```ruby
|
29
|
+
require 'primary_connect_client'
|
30
|
+
|
31
|
+
instance = PrimaryConnectClient::Result.new(
|
32
|
+
code: null,
|
33
|
+
related_group_id: null,
|
34
|
+
specimen: null,
|
35
|
+
value: negative,
|
36
|
+
value_type: STRING,
|
37
|
+
completion_date_time: 2021-07-10T12:35:45-07:00,
|
38
|
+
report: null,
|
39
|
+
units: null,
|
40
|
+
notes: null,
|
41
|
+
abnormal_flag: null,
|
42
|
+
status: null,
|
43
|
+
primary_results_interpreter: null,
|
44
|
+
producer: null,
|
45
|
+
performer: null,
|
46
|
+
reference_range: null,
|
47
|
+
observation_method: null,
|
48
|
+
producer_order_id: 12345678,
|
49
|
+
finding_value: null
|
50
|
+
)
|
51
|
+
```
|
52
|
+
|
data/docs/ResultIds.md
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# PrimaryConnectClient::ResultIds
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **results** | **Array<String>** | List of Result IDs | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'primary_connect_client'
|
13
|
+
|
14
|
+
instance = PrimaryConnectClient::ResultIds.new(
|
15
|
+
results: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|