mirah-ruby 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76ec40df793b5716ae1e5f3ab4ff5c2163634910af216668912de9861d357d2f
-  data.tar.gz: 166a1138b4a93f953b1914ebdd13785fcf8f175bc2615c3c19c813ba116c32f0
+  metadata.gz: 41451cd5cce251f00e1436c8a7aae2140fe8fbc0c34b8a559531684cbc415c10
+  data.tar.gz: 51b5c3d5095058f4da1b2e0ac5fd36f9fcfdf00ac43dba25b499a0254b87b05b
 SHA512:
-  metadata.gz: 6f9d8daebe43ffc1e5e95e98cb8ae37fd82ef3a412c773291e82cbb4a9ed294cd339e74a3999388dc6b564d333ac36209a444235803155be78daa1c186d64deb
-  data.tar.gz: 0071b8cba8dfc1d09d7fb731cd55f2719af3d4e1d57fe1b9366d95a64befa6c93f393e5018d08516c45e77f30a6d2eb3bdecdd3ceb4c67d11dd5d521ed3c6aac
+  metadata.gz: 8a0f1ccd84d3b52be85a2639127815ee2614f1a629c72f88d2b0e2629989b69112343f49990f732bc346016b79ffbc19c0fc26e208e06a065f2e9fc72321dc05
+  data.tar.gz: a2e0cb5cfb08bb316255ab708c1167d555e29b67cd753ac97a5aca447a640c20f67c497d9a8aa92a1b124045c1957d9420d501ae43a524c425d635ab623baec0

data/.circleci/config.yml

@@ -5,15 +5,13 @@ orbs:
 jobs:
   test24:
     docker:
-      - image: circleci/ruby:2.4.6-stretch-node
+      - image: cimg/ruby:2.4
     executor: ruby/default
     steps:
       - checkout
       - run:
           name: Configure Bundler
           command: |
-            echo 'export BUNDLER_VERSION=1.16.6' >> $BASH_ENV
-            source $BASH_ENV
             gem install bundler
       - run:
           name: Which bundler?
@@ -24,15 +22,13 @@ jobs:
           command: bundle exec rake spec
   test25:
     docker:
-      - image: circleci/ruby:2.5-stretch-node
+      - image: cimg/ruby:2.5
     executor: ruby/default
     steps:
       - checkout
       - run:
           name: Configure Bundler
           command: |
-            echo 'export BUNDLER_VERSION=1.16.6' >> $BASH_ENV
-            source $BASH_ENV
             gem install bundler
       - run:
           name: Which bundler?
@@ -43,7 +39,7 @@ jobs:
           command: bundle exec rake spec
   test26:
     docker:
-      - image: circleci/ruby:2.6-stretch-node
+      - image: cimg/ruby:2.6
     executor: ruby/default
     steps:
       - checkout
@@ -62,7 +58,26 @@ jobs:
           command: bundle exec rake spec
   test27:
     docker:
-      - image: circleci/ruby:2.7-node
+      - image: cimg/ruby:2.7
+    executor: ruby/default
+    steps:
+      - checkout
+      - run:
+          name: Configure Bundler
+          command: |
+            echo 'export BUNDLER_VERSION=2.1.4' >> $BASH_ENV
+            source $BASH_ENV
+            gem install bundler
+      - run:
+          name: Which bundler?
+          command: bundle -v
+      - ruby/bundle-install
+      - run:
+          name: Tests
+          command: bundle exec rake spec
+  test31:
+    docker:
+      - image: cimg/ruby:3.1.2
     executor: ruby/default
     steps:
       - checkout
@@ -81,6 +96,7 @@ jobs:
           command: bundle exec rake spec
 
 
+
 workflows:
   version: 2
   test:
@@ -89,5 +105,6 @@ workflows:
       - test25
       - test26
       - test27
+      - test31
 
       

data/lib/mirah/client.rb

@@ -104,7 +104,8 @@ module Mirah
     # @option input_values [String, nil] :primary_language see {Data::Patient#primary_language}
     # @option input_values [String, nil] :email see {Data::Patient#email}
     # @option input_values [String, nil] :phone_number see {Data::Patient#phone_number}
-    # @option input_values [String, nil] :external_managing_organization_id see {Data::Patient#external_managing_organization_id}
+    # @option input_values [String, nil] :external_managing_organization_id
+    #                                     see {Data::Patient#external_managing_organization_id}
     # @return [PushResult<Data::Patient>] the operation result with a patient on success
     def push_patient(external_id:, **input_values)
       mutate(Graphql::Mutations::CreateOrUpdatePatientMutation,
@@ -301,6 +302,123 @@ module Mirah
              Data::Appointment, 'createOrUpdateAppointment')
     end
 
+    #################################################################################################################
+    # DIAGNOSTIC CODE METHODS
+    #################################################################################################################
+
+    # Find an diagnostic code by the given Mirah internal UUID. This method should be used if you already know the Mirah
+    # identifier. If you wish to query by your own system identifier, you should use
+    # {#find_diagnostic_code_by_external_id}
+    #
+    # @since 0.4.0
+    # @param id [String] Mirah UUID for the diagnostic code
+    # @return [Data::DiagnosticCode, nil] the code, or nil if the record does not exist.
+    def find_diagnostic_code(id)
+      query_record(Graphql::Queries::DiagnosticCodeIdQuery, id, Data::DiagnosticCode, 'diagnosticCode')
+    end
+
+    # Find a diagnostic code by your external id. This is a convenience method. If you wish to query a list of
+    # codes by external id, please use {Client#query_diagnostic_codes}.
+    #
+    # @since 0.4.0
+    # @param external_id [String] The identifier of the system of record
+    # @return [Data::DiagnosticCode, nil] the code, or nil if the record does not exist.
+    def find_diagnostic_code_by_external_id(external_id)
+      query_record_by_external_id(Graphql::Queries::DiagnosticCodeExternalIdQuery,
+                                  external_id,
+                                  Data::DiagnosticCode,
+                                  'diagnosticCodeExternal')
+    end
+
+    # Query for diagnostic codes. You may specify a set of parameters as defined in
+    # {Mirah::Filters::DiagnosticCodeFilters}.
+    # Results are returned in a paginated format. See {Collection} for how to page results.
+    # @since 0.4.0
+    # @param external_id [Array<String>] See {Mirah::Filters::DiagnosticCodeFilters#external_id}
+    # @param search [Array<String>] See {Mirah::Filters::DiagnosticCodeFilters#search}
+    # @return [Collection<Data::Appointment>] a collection of pageable codes.
+    def query_diagnostic_codes(external_id: nil, search: nil)
+      query_connection(
+        Graphql::Queries::DiagnosticCodeQuery,
+        Filters::DiagnosticCodeFilters.new(external_id: external_id, search: search),
+        Filters::Paging.default,
+        Data::DiagnosticCode,
+        'diagnosticCodes'
+      )
+    end
+
+    # Create or update a diagnosis code. You must specify an external identifier, all other parameters are optional,
+    # but you may receive errors if you attempt to specify too few parameters for an appointment that does not exist.
+    #
+    # @since 0.1.0
+    # @param external_id [String] the external identifier for this code
+    # @option input_values [String, nil] :name see {Data::DiagnosticCode#name}
+    # @option input_values [String, nil] :code see {Data::DiagnosticCode#code}
+    # @return [PushResult<Data::DiagnosticCode>] the operation result with the code on success
+    def push_diagnostic_code(external_id:, **input_values)
+      mutate(Graphql::Mutations::CreateOrUpdateDiagnosticCodeMutation,
+             Inputs::DiagnosticCodeInput.new(input_values.merge(external_id: external_id)),
+             Data::DiagnosticCode, 'createOrUpdateDiagnosticCode')
+    end
+
+    #################################################################################################################
+    # PATIENT CONDITION METHODS
+    #################################################################################################################
+
+    # Find an condition by the given Mirah internal UUID. This method should be used if you already know the Mirah
+    # identifier. If you wish to query by your own system identifier, you should use
+    # {#find_patient_condition_by_external_id}
+    #
+    # @since 0.4.0
+    # @param id [String] Mirah UUID for the condition
+    # @return [Data::PatientCondition, nil] the code, or nil if the record does not exist.
+    def find_patient_condition(id)
+      query_record(Graphql::Queries::PatientConditionIdQuery, id, Data::PatientCondition, 'patientCondition')
+    end
+
+    # Find a condition by your external id. This is a convenience method. If you wish to query a list of
+    # codes by external id, please use {Client#query_patient_conditions}.
+    #
+    # @since 0.4.0
+    # @param external_id [String] The identifier of the system of record
+    # @return [Data::PatientCondition, nil] the code, or nil if the record does not exist.
+    def find_patient_condition_by_external_id(external_id)
+      query_record_by_external_id(Graphql::Queries::PatientConditionExternalIdQuery,
+                                  external_id,
+                                  Data::PatientCondition,
+                                  'patientConditionExternal')
+    end
+
+    # Query for conditions. You may specify a set of parameters as defined in
+    # {Mirah::Filters::PatientConditionFilters}.
+    # Results are returned in a paginated format. See {Collection} for how to page results.
+    # @since 0.4.0
+    # @param external_id [Array<String>] See {Mirah::Filters::PatientConditionFilters#external_id}
+    # @return [Collection<Data::Appointment>] a collection of pageable codes.
+    def query_patient_conditions(external_id: nil)
+      query_connection(
+        Graphql::Queries::PatientConditionQuery,
+        Filters::PatientConditionFilters.new(external_id: external_id),
+        Filters::Paging.default,
+        Data::PatientCondition,
+        'patientConditions'
+      )
+    end
+
+    # Create or update a condition. You must specify an external identifier, all other parameters are optional,
+    # but you may receive errors if you attempt to specify too few parameters for an appointment that does not exist.
+    #
+    # @since 0.1.0
+    # @param external_id [String] the external identifier for this code
+    # @option input_values [String, nil] :name see {Data::PatientCondition#name}
+    # @option input_values [String, nil] :code see {Data::PatientCondition#code}
+    # @return [PushResult<Data::PatientCondition>] the operation result with the code on success
+    def push_patient_condition(external_id:, **input_values)
+      mutate(Graphql::Mutations::CreateOrUpdatePatientConditionMutation,
+             Inputs::PatientConditionInput.new(input_values.merge(external_id: external_id)),
+             Data::PatientCondition, 'createOrUpdatePatientCondition')
+    end
+
     ##################################################################################################################
     # Internal methods
     ##################################################################################################################
@@ -411,7 +529,7 @@ module Mirah
         if response.errors[:data] == ['401 Unauthorized'] # rubocop:disable Style/GuardClause
           raise Errors::InvalidCredentials, 'The credentials you have supplied are invalid'
         else
-          raise Errors::ServerError, 'Unknown error from Mirah server: ' + response.errors.values.flatten.join(',')
+          raise Errors::ServerError, "Unknown error from Mirah server: #{response.errors.values.flatten.join(',')}"
         end
       end
 

data/lib/mirah/data/diagnostic_code.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Mirah
+  module Data
+    # Diagnostic codes represent ICD10 or other codes that contain information on diagnosis. The Mirah system models
+    # this simply as a code and a name, effectively operating like a tag.
+    # For example, Major Depressive Disorder could be represented with the code F320.
+    class DiagnosticCode < BaseObject
+      # @!attribute [r] id
+      #   @return [string] The internal Mirah identifier
+      attribute :id
+
+      # @!attribute [r] external_id
+      #   @return [string] The identifier provided by your system
+      attribute :external_id
+
+      # @!attribute [r] name
+      #   @return [string] A description of the code, e.g. "Major Depressive Disorder"
+      attribute :name
+
+      # @!attribute [r] code
+      #   @return [string] A string representing the code, e.g. "F320"
+      attribute :code
+    end
+  end
+end

data/lib/mirah/data/patient.rb

@@ -15,12 +15,42 @@ module Mirah
 
       # @!attribute [r] given_name
       #   @return [string] The patient's first or given name
+      # @deprecated use legal_given_name instead
       attribute :given_name
 
+      # @!attribute [r] legal_given_name
+      #   @return [string] The patient's legal first or given name
+      attribute :legal_given_name
+
+      # @!attribute [r] preferred_given_name
+      #   @return [string] The patient's preferred first or given name
+      attribute :preferred_given_name
+
       # @!attribute [r] family_name
       #   @return [string] The patient's last or family name
+      # @deprecated use legal_family_name instead
       attribute :family_name
 
+      # @!attribute [r] legal_family_name
+      #   @return [string] The patient's legal last or family name
+      attribute :legal_family_name
+
+      # @!attribute [r] preferred_family_name
+      #   @return [string] The patient's preferred last or family name
+      attribute :preferred_family_name
+
+      # @!attribute [r] legal_name
+      #   @return [string] The patient's full legal name.
+      attribute :legal_name
+
+      # @!attribute [r] preferred_name
+      #   @return [string] The patient's full preferred name.
+      attribute :preferred_name
+
+      # @!attribute [r] preferred_pronouns
+      #   @return [string] The patient's preferred pronouns.
+      attribute :preferred_pronouns
+
       # @!attribute [r] birth_date
       #   @return [Date] The patient's date of birth.
       attribute :birth_date, serializer: Serializers::DateSerializer.new
@@ -29,6 +59,14 @@ module Mirah
       #   @return [string] The patient's gender
       attribute :gender
 
+      # @!attribute [r] gender_identity
+      #   @return [string] The patient's gender identity as free text
+      attribute :gender_identity
+
+      # @!attribute [r] gender_identity_fhir
+      #   @return [string] The patient's gender identity as FHIR extension coded.
+      attribute :gender_identity_fhir
+
       # @!attribute [r] primary_language
       #   @return [string] The patient's primary language
       attribute :primary_language
@@ -42,6 +80,11 @@ module Mirah
       #    Please do not use a phone number which corresponds to a landline as text messages will not be received.
       attribute :phone_number
 
+      # @!attribute [r] timezone
+      #   @return [string] The patient's timezone. If not specified, the organization's default will be used. Timezone
+      #    should be formatted like: https://en.wikipedia.org/wiki/Tz_database
+      attribute :timezone
+
       # @!attribute [r] managing_organization_id
       #   @return [string] The internal mirah id of the organization this patient is with
       attribute :managing_organization_id, path: %w[managingOrganization], target: 'id'

data/lib/mirah/data/patient_condition.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Mirah
+  module Data
+    class PatientCondition < BaseObject
+      # @!attribute [r] id
+      #   @return [string] The internal Mirah identifier
+      attribute :id
+
+      # @!attribute [r] external_id
+      #   @return [string] The identifier provided by your system
+      attribute :external_id
+
+      # @!attribute [r] status
+      #   @return [string] The status of this condition
+      attribute :status
+
+      # @!attribute [r] onset_date
+      #   @return [string] The date of onset
+      attribute :onset_date, serializer: Serializers::DateTimeSerializer.new
+
+      # @!attribute [r] abatement_date
+      #   @return [string] The date of abatement
+      attribute :abatement_date, serializer: Serializers::DateTimeSerializer.new
+
+      # @!attribute [r] patient_id
+      #   @return [string] The internal mirah id of the patient the condition applies to
+      attribute :patient_id, path: %w[patient], target: 'id'
+
+      # @!attribute [r] external_patient_id
+      #   @return [string] Your system identifier for the patient the condition applies to
+      attribute :external_patient_id, path: %w[patient], target: 'externalId'
+
+      # @!attribute [r] diagnostic_code_id
+      #   @return [string] The internal mirah id of the code the patient has been diagnosed with
+      attribute :diagnostic_code_id, path: %w[diagnosticCode], target: 'id'
+
+      # @!attribute [r] external_diagnostic_code_id
+      #   @return [string] Your system identifier for the code the patient has been diagnosed with
+      attribute :external_diagnostic_code_id, path: %w[diagnosticCode], target: 'externalId'
+    end
+  end
+end

data/lib/mirah/filters/diagnostic_code_filters.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Mirah
+  module Filters
+    # Input parameters and filters for queries returning {Data::DiagnosticCode} objects.
+    class DiagnosticCodeFilters < BaseObject
+      # @!attribute [r] external_id
+      #   @return [Array<string>] An array of external identifiers to match.
+      attribute :external_id
+
+      # @!attribute [r] search
+      #   @return [string] Smart search by name and other fields where appropriate
+      attribute :search
+    end
+  end
+end

data/lib/mirah/filters/patient_condition_filters.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Mirah
+  module Filters
+    # Input parameters and filters for queries returning {Data::PatientCondition} objects.
+    class PatientConditionFilters < BaseObject
+      # @!attribute [r] external_id
+      #   @return [Array<string>] An array of external identifiers to match.
+      attribute :external_id
+    end
+  end
+end

data/lib/mirah/graphql/fragments.rb

@@ -24,6 +24,7 @@ module Mirah
           primaryLanguage
           email
           phoneNumber
+          timezone
           managingOrganization {
             id
             externalId
@@ -106,6 +107,39 @@ module Mirah
           }
         }
       GRAPHQL
+
+      DiagnosticCodeFragment = Graphql::ValidationClient.parse <<-'GRAPHQL'
+        fragment on DiagnosticCode {
+          id
+          externalId
+          name
+          code
+          identifier {
+            value
+          }
+        }
+      GRAPHQL
+
+      PatientConditionFragment = Graphql::ValidationClient.parse <<-'GRAPHQL'
+        fragment on PatientCondition {
+          id
+          externalId
+          patient {
+            id
+            externalId
+          }
+          diagnosticCode {
+            id
+            externalId
+          }
+          identifier {
+            value
+          }
+          onsetDate
+          abatementDate
+          status
+        }
+      GRAPHQL
     end
   end
 end

data/lib/mirah/graphql/mutations.rb

@@ -67,6 +67,38 @@ module Mirah
           }
         }
       GRAPHQL
+
+      # Create or update a diagnostic code
+      CreateOrUpdateDiagnosticCodeMutation = Graphql::ValidationClient.parse <<-'GRAPHQL'
+        mutation($input: CreateOrUpdateDiagnosticCodeInput!) {
+          createOrUpdateDiagnosticCode(input: $input) {
+            status
+            errors {
+              path
+              message
+            }
+            result {
+            ...Mirah::Graphql::Fragments::DiagnosticCodeFragment
+            }
+          }
+        }
+      GRAPHQL
+
+      # Create or update a patient condition
+      CreateOrUpdatePatientConditionMutation = Graphql::ValidationClient.parse <<-'GRAPHQL'
+        mutation($input: CreateOrUpdatePatientConditionInput!) {
+          createOrUpdatePatientCondition(input: $input) {
+            status
+            errors {
+              path
+              message
+            }
+            result {
+            ...Mirah::Graphql::Fragments::PatientConditionFragment
+            }
+          }
+        }
+      GRAPHQL
     end
   end
 end

data/lib/mirah/graphql/queries.rb

@@ -191,6 +191,98 @@ module Mirah
           }
         }
       GRAPHQL
+
+      #========================================================================
+      # DIAGNOSTIC CODE QUERIES
+      #========================================================================
+
+      DiagnosticCodeQuery = Graphql::ValidationClient.parse <<-'GRAPHQL'
+        query(
+          $first: Int
+          $last: Int
+          $after: String
+          $before: String,
+          $externalId: [String!],
+          $search: String
+        ) {
+          diagnosticCodes(
+            first: $first
+            after: $after
+            before: $before
+            last: $last,
+            externalId: $externalId,
+            search: $search
+          ) {
+            nodes {
+              ...Mirah::Graphql::Fragments::DiagnosticCodeFragment
+            }
+            pageInfo {
+              ...Mirah::Graphql::Fragments::PageInfoFragment
+            }
+          }
+        }
+      GRAPHQL
+
+      DiagnosticCodeIdQuery = Graphql::ValidationClient.parse <<-'GRAPHQL'
+        query($id: ID!) {
+          diagnosticCode(id: $id) {
+            ...Mirah::Graphql::Fragments::DiagnosticCodeFragment
+          }
+        }
+      GRAPHQL
+
+      DiagnosticCodeExternalIdQuery = Graphql::ValidationClient.parse <<-'GRAPHQL'
+        query($externalId: String!) {
+          diagnosticCodeExternal(externalId: $externalId) {
+            ...Mirah::Graphql::Fragments::DiagnosticCodeFragment
+          }
+        }
+      GRAPHQL
+
+      #========================================================================
+      # PATIENT CONDITION QUERIES
+      #========================================================================
+
+      PatientConditionQuery = Graphql::ValidationClient.parse <<-'GRAPHQL'
+        query(
+          $first: Int
+          $last: Int
+          $after: String
+          $before: String,
+          $externalId: [String!]
+        ) {
+          patientConditions(
+            first: $first
+            after: $after
+            before: $before
+            last: $last,
+            externalId: $externalId
+          ) {
+            nodes {
+              ...Mirah::Graphql::Fragments::PatientConditionFragment
+            }
+            pageInfo {
+              ...Mirah::Graphql::Fragments::PageInfoFragment
+            }
+          }
+        }
+      GRAPHQL
+
+      PatientConditionIdQuery = Graphql::ValidationClient.parse <<-'GRAPHQL'
+        query($id: ID!) {
+          patientCondition(id: $id) {
+            ...Mirah::Graphql::Fragments::PatientConditionFragment
+          }
+        }
+      GRAPHQL
+
+      PatientConditionExternalIdQuery = Graphql::ValidationClient.parse <<-'GRAPHQL'
+        query($externalId: String!) {
+          patientConditionExternal(externalId: $externalId) {
+            ...Mirah::Graphql::Fragments::PatientConditionFragment
+          }
+        }
+      GRAPHQL
     end
   end
 end

data/lib/mirah/inputs/diagnostic_code_input.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Mirah
+  module Inputs
+    # A set of parameters for updating a {Data::DiagnosticCocde}
+    class DiagnosticCodeInput < BaseInputObject
+      # @!attribute [r] external_id
+      #   @return (see Mirah::Data::DiagnosticCode#external_id)
+      input :external_id, required: true
+
+      # @!attribute [r] name
+      #   @return (see Mirah::Data::DiagnosticCode#name)
+      input :name, required: false
+
+      # @!attribute [r] name
+      #   @return (see Mirah::Data::DiagnosticCode#code)
+      input :code, required: false
+    end
+  end
+end

data/lib/mirah/inputs/patient_condition_input.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Mirah
+  module Inputs
+    # A set of parameters for updating a {Data::Appointment}
+    class PatientConditionInput < BaseInputObject
+      # @!attribute [r] external_id
+      #   @return (see Mirah::Data::PatientCondition#external_id)
+      input :external_id, required: true
+
+      # @!attribute [r] onset_date
+      #   @return (see Mirah::Data::PatientCondition#onset_date)
+      input :onset_date, required: false, serializer: Serializers::DateTimeSerializer.new
+
+      # @!attribute [r] abatement_date
+      #   @return (see Mirah::Data::PatientCondition#abatement_date)
+      input :abatement_date, required: false, serializer: Serializers::DateTimeSerializer.new
+
+      # @!attribute [r] status
+      #   @return (see Mirah::Data::PatientCondition#status)
+      input :status, required: true
+
+      # @!attribute [r] external_patient_id
+      #   @return (see Mirah::Data::PatientCondition#external_patient_id)
+      input :external_patient_id, required: false
+
+      # @!attribute [r] external_diagnostic_code_id
+      #   @return (see Mirah::Data::PatientCondition#external_diagnostic_code_id)
+      input :external_diagnostic_code_id, required: false
+    end
+  end
+end