health_cards 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6e94c49814ad651b6377277252fef1276ca99fa3b0704171f31571a986da62e
-  data.tar.gz: 9a3a9b0e599a196d70d498089b23efb2479cece350f3bd1cb430ffbe4f22a32b
+  metadata.gz: 68a66d710cdd4d93e04b20f5dfdd9391523c3499b1d1ce2b006ed0bf5bb9ab65
+  data.tar.gz: 1b6d3a3c8819a1815aa4b9950610693b5f941c17ac568f5213c2735c776ba89f
 SHA512:
-  metadata.gz: 39f9f579182341ec4124c991962ab8c7fcd8a09e5ced6e456a7f61248bc53c4a80b4b65a8eed2ba7756ecb29f8a68c8c8625017aad43a4cf38baa62ff3334194
-  data.tar.gz: c9c486b517e6c4e07299662700c50e53be4286b870abeccc1114d042f216ba0489069770a1c574cdae3b6e852a07738749901109c84644ebba42869baf150b3f
+  metadata.gz: 8d4da867fb565f3cea48355d94edf36f30e6cccf59b15c85219b1aab54bf7b7172fe8482e7571a57a3322abe9cbaf11c69fe10350e3a94f60d87516b5ba9fb2b
+  data.tar.gz: e1ab50714275959ebcdef0065a2048d7fa0ec5147b2cb4aca0461999c4c3775eb118cc1c84b7a2167058e42288708495975a2df7ebf8df24a90d77b44b482736

data/lib/health_cards/attribute_filters.rb

@@ -9,9 +9,9 @@ module HealthCards
       base.extend ClassMethods
     end
 
-    # Class level methods for HealthCard class specific settings
+    # Class level methods for Payload class specific settings
     module ClassMethods
-      # Define allowed attributes for this HealthCard class
+      # Define allowed attributes for this Payload class
       # @param type [Class] Scopes the attributes to a spefic class. Must be a subclass of FHIR::Model
       # @param attributes [Array] An array of string with the attribute names that will be passed through
       #  when data is minimized
@@ -19,7 +19,7 @@ module HealthCards
         allowable[type] = attributes
       end
 
-      # Define disallowed attributes for this HealthCard class
+      # Define disallowed attributes for this Payload class
       # @param type [Class] Scopes the attributes to a spefic class. If not used will default to all FHIR resources.
       # To apply a rule to all FHIR types (resources and types), use FHIR::Model as the type
       # @param attributes [Array] An array of string with the attribute names that will be passed through
@@ -29,7 +29,7 @@ module HealthCards
         disallowable[type].concat(attributes)
       end
 
-      # Define disallowed attributes for this HealthCard class
+      # Define disallowed attributes for this Payload class
       # @return [Hash] A hash of FHIR::Model subclasses and attributes that will pass through minimization
       def disallowable
         return @disallowable if @disallowable
@@ -37,7 +37,7 @@ module HealthCards
         @disallowable = parent_disallowables
       end
 
-      # Define allowed attributes for this HealthCard class
+      # Define allowed attributes for this Payload class
       # @return [Hash] A hash of FHIR::Model subclasses and attributes that will pass through minimization
       def allowable
         return @allowable if @allowable
@@ -48,11 +48,11 @@ module HealthCards
       protected
 
       def parent_allowables(base = {})
-        self < HealthCards::HealthCard ? base.merge(superclass.allowable) : base
+        self < HealthCards::Payload ? base.merge(superclass.allowable) : base
       end
 
       def parent_disallowables(base = {})
-        self < HealthCards::HealthCard ? base.merge(superclass.disallowable) : base
+        self < HealthCards::Payload ? base.merge(superclass.disallowable) : base
       end
     end
 
@@ -61,7 +61,7 @@ module HealthCards
 
       return unless class_allowables
 
-      allowed = resource.to_hash.select! { |att| class_allowables.include?(att) }
+      allowed = resource.to_hash.keep_if { |att| class_allowables.include?(att) }
 
       resource.from_hash(allowed)
     end

data/lib/health_cards/chunk.rb

@@ -1,92 +1,32 @@
 # frozen_string_literal: true
 
-# rubocop:disable Lint/MissingSuper
 module HealthCards
   # Represents a single QRCode in a sequence. This class is a shim to the RQRCode library
   # to enable multimode encoding
-  class Chunk < RQRCode::QRCode
-    attr_reader :ordinal
+  class Chunk
+    attr_reader :ordinal, :data, :qrcode
 
-    def data
-      @qrcode.data
-    end
+    SINGLE_REGEX = %r{shc:/}.freeze
+    MULTI_REGEX = %r{shc:/[0-9]*/[0-9]*/}.freeze
 
-    def initialize(ordinal: 1, input: nil)
+    def initialize(input:, ordinal: 1)
       @ordinal = ordinal
-      @qrcode = ChunkCore.new(input)
-    end
-
-    def image
-      as_png(
-        border_modules: 1,
-        module_px_size: 2
-      )
-    end
-  end
-
-  # RQRCodeCore shim for to enable multimode encoding
-  class ChunkCore < RQRCodeCore::QRCode
-    attr_accessor :data
-
-    def initialize(input)
       @data = input
-      @error_correct_level = 1
-      @version = 22
-      @module_count = @version * 4 + RQRCodeCore::QRPOSITIONPATTERNLENGTH
-      @modules = Array.new(@module_count)
-      @data_list = SHCQRCode.new(@data)
-      @data_cache = nil
-      make
-    end
-
-    # RQRCodeCore data shim for multimode encoding
-    class SHCQRCode
-      SINGLE_REGEX = %r{shc:/}.freeze
-      MULTI_REGEX = %r{shc:/[0-9]*/[0-9]*/}.freeze
-
-      def initialize(data)
-        @data = data
-      end
+      multi = MULTI_REGEX.match(input)
 
-      def write(buffer)
-        multi = MULTI_REGEX.match(@data)
-        prefix = multi ? multi.to_s : SINGLE_REGEX.match(@data).to_s
+      prefix = multi ? multi.to_s : SINGLE_REGEX.match(input).to_s
+      content = input.delete_prefix(prefix)
 
-        buffer.byte_encoding_start(prefix.length)
-
-        prefix.each_byte do |b|
-          buffer.put(b, 8)
-        end
-
-        num_content = @data.delete_prefix(prefix)
-
-        buffer.numeric_encoding_start(num_content.length)
-
-        num_content.size.times do |i|
-          next unless (i % 3).zero?
-
-          chars = num_content[i, 3]
-          bit_length = get_bit_length(chars.length)
-          buffer.put(get_code(chars), bit_length)
-        end
-      end
-
-      private
-
-      NUMBER_LENGTH = {
-        3 => 10,
-        2 => 7,
-        1 => 4
-      }.freeze
+      @qrcode = RQRCode::QRCode.new([{ mode: :byte_8bit, data: prefix }, { mode: :number, data: content }],
+                                    max_size: 22, level: :l)
+    end
 
-      def get_bit_length(length)
-        NUMBER_LENGTH[length]
-      end
+    def qr_code
+      @qrcode.qrcode
+    end
 
-      def get_code(chars)
-        chars.to_i
-      end
+    def image
+      @qrcode.as_png(module_px_size: 2)
     end
   end
 end
-# rubocop:enable Lint/MissingSuper

data/lib/health_cards/errors.rb

@@ -25,7 +25,7 @@ module HealthCards
 
   class UnresolvableKeySetError < JWSError; end
 
-  # Errors related to HealthCard / Bundle
+  # Errors related to Payload / Bundle
 
   # Exception thrown when an invalid payload is provided
   class InvalidPayloadError < HealthCardError

data/lib/health_cards/exporter.rb

@@ -7,7 +7,7 @@ module HealthCards
       # Export JWS for file download
       # @param [Array<JWS, String>] An array of JWS objects to be exported
       # @return [String] JSON string containing file download contents
-      def download(jws)
+      def file_download(jws)
         { verifiableCredential: jws.map(&:to_s) }.to_json
       end
 

data/lib/health_cards/health_card.rb

@@ -1,203 +1,69 @@
 # frozen_string_literal: true
 
-require 'zlib'
-require 'uri'
-
-require 'health_cards/attribute_filters'
-require 'health_cards/card_types'
-
 module HealthCards
-  # A HealthCard which implements the credential claims specified by https://smarthealth.cards/
+  # Represents a signed SMART Health Card
   class HealthCard
-    include HealthCards::AttributeFilters
-    extend HealthCards::CardTypes
-
-    FHIR_REF_REGEX = %r{((http|https)://([A-Za-z0-9\-\\.:%$]*/)+)?(
-      Account|ActivityDefinition|AdverseEvent|AllergyIntolerance|Appointment|AppointmentResponse|AuditEvent|Basic|
-      Binary|BiologicallyDerivedProduct|BodyStructure|Bundle|CapabilityStatement|CarePlan|CareTeam|CatalogEntry|
-      ChargeItem|ChargeItemDefinition|Claim|ClaimResponse|ClinicalImpression|CodeSystem|Communication|
-      CommunicationRequest|CompartmentDefinition|Composition|ConceptMap|Condition|Consent|Contract|Coverage|
-      CoverageEligibilityRequest|CoverageEligibilityResponse|DetectedIssue|Device|DeviceDefinition|DeviceMetric
-      |DeviceRequest|DeviceUseStatement|DiagnosticReport|DocumentManifest|DocumentReference|EffectEvidenceSynthesis|
-      Encounter|Endpoint|EnrollmentRequest|EnrollmentResponse|EpisodeOfCare|EventDefinition|Evidence|EvidenceVariable|
-      ExampleScenario|ExplanationOfBenefit|FamilyMemberHistory|Flag|Goal|GraphDefinition|Group|GuidanceResponse|
-      HealthcareService|ImagingStudy|Immunization|ImmunizationEvaluation|ImmunizationRecommendation|
-      ImplementationGuide|InsurancePlan|Invoice|Library|Linkage|List|Location|Measure|MeasureReport|Media|Medication|
-      MedicationAdministration|MedicationDispense|MedicationKnowledge|MedicationRequest|MedicationStatement|
-      MedicinalProduct|MedicinalProductAuthorization|MedicinalProductContraindication|MedicinalProductIndication|
-      MedicinalProductIngredient|MedicinalProductInteraction|MedicinalProductManufactured|MedicinalProductPackaged|
-      MedicinalProductPharmaceutical|MedicinalProductUndesirableEffect|MessageDefinition|MessageHeader|
-      MolecularSequence|NamingSystem|NutritionOrder|Observation|ObservationDefinition|OperationDefinition|
-      OperationOutcome|Organization|OrganizationAffiliation|Patient|PaymentNotice|PaymentReconciliation|Person|
-      PlanDefinition|Practitioner|PractitionerRole|Procedure|Provenance|Questionnaire|QuestionnaireResponse|
-      RelatedPerson|RequestGroup|ResearchDefinition|ResearchElementDefinition|ResearchStudy|ResearchSubject|
-      RiskAssessment|RiskEvidenceSynthesis|Schedule|SearchParameter|ServiceRequest|Slot|Specimen|SpecimenDefinition|
-      StructureDefinition|StructureMap|Subscription|Substance|SubstanceNucleicAcid|SubstancePolymer|SubstanceProtein|
-      SubstanceReferenceInformation|SubstanceSourceMaterial|SubstanceSpecification|SupplyDelivery|SupplyRequest|Task|
-      TerminologyCapabilities|TestReport|TestScript|ValueSet|VerificationResult|VisionPrescription)/
-      [A-Za-z0-9\-.]{1,64}(/_history/[A-Za-z0-9\-.]{1,64})?}x.freeze
-
-    attr_reader :issuer, :nbf, :bundle
-
-    class << self
-      # Creates a HealthCard from a JWS
-      # @param jws [String] the JWS string
-      # @param public_key [HealthCards::PublicKey] the public key associated with the JWS
-      # @param key [HealthCards::PrivateKey] the private key associated with the JWS
-      # @return [HealthCards::HealthCard]
-      def from_jws(jws, public_key: nil, key: nil)
-        jws = JWS.from_jws(jws, public_key: public_key, key: key)
-        from_payload(jws.payload)
-      end
-
-      # Create a HealthCard from a compressed payload
-      # @param payload [String]
-      # @return [HealthCards::HealthCard]
-      def from_payload(payload)
-        json = decompress_payload(payload)
-        bundle_hash = json.dig('vc', 'credentialSubject', 'fhirBundle')
-
-        raise HealthCards::InvalidCredentialError unless bundle_hash
-
-        bundle = FHIR::Bundle.new(bundle_hash)
-        new(issuer: json['iss'], bundle: bundle)
-      end
-
-      # Decompress an arbitrary payload, useful for debugging
-      # @param payload [String] compressed payload
-      # @return [Hash] Hash built from JSON contents of payload
-      def decompress_payload(payload)
-        inf = Zlib::Inflate.new(-Zlib::MAX_WBITS).inflate(payload)
-        JSON.parse(inf)
-      end
-
-      # Compress an arbitrary payload, useful for debugging
-      # @param payload [Object] Any object that responds to to_s
-      # @return A compressed version of that payload parameter
-      def compress_payload(payload)
-        Zlib::Deflate.new(nil, -Zlib::MAX_WBITS).deflate(payload.to_s, Zlib::FINISH)
-      end
-
-      # Sets/Gets the fhir version that will be passed through to the credential created by an instnace of
-      # this HealthCard (sub)class
-      # @param ver [String] FHIR Version supported by this HealthCard (sub)class. Leaving this param out
-      # will only return the current value
-      # value (used as a getter)
-      # @return [String] Current FHIR version supported
-      def fhir_version(ver = nil)
-        @fhir_version ||= ver unless ver.nil?
-        @fhir_version
-      end
-    end
+    extend Forwardable
 
-    allow type: FHIR::Meta, attributes: %w[security]
+    attr_reader :jws
 
-    disallow attributes: %w[id text]
-    disallow type: FHIR::CodeableConcept, attributes: %w[text]
-    disallow type: FHIR::Coding, attributes: %w[display]
+    def_delegator :@qr_codes, :code_by_ordinal
+    def_delegators :@payload, :bundle, :issuer
 
-    # Create a HealthCard
-    #
-    # @param bundle [FHIR::Bundle] VerifiableCredential containing a fhir bundle
-    # @param issuer [String] The url from the Issuer of the HealthCard
-    def initialize(bundle:, issuer: nil)
-      raise InvalidPayloadError unless bundle.is_a?(FHIR::Bundle) # && bundle.valid?
-
-      @issuer = issuer
-      @bundle = bundle
+    # Create a HealthCard from a JWS
+    # @param jws [JWS, String] A JWS object or JWS string
+    def initialize(jws)
+      @jws = JWS.from_jws(jws)
+      @payload = Payload.from_payload(@jws.payload)
+      @qr_codes = QRCodes.from_jws(@jws)
     end
 
-    # A Hash matching the VC structure specified by https://smarthealth.cards/#health-cards-are-encoded-as-compact-serialization-json-web-signatures-jws
-    # @return [Hash]
-    def to_hash
-      {
-        iss: issuer,
-        nbf: Time.now.to_i,
-        vc: {
-          type: self.class.types,
-          credentialSubject: {
-            fhirVersion: self.class.fhir_version,
-            fhirBundle: strip_fhir_bundle.to_hash
-          }
-        }
-      }
+    # Export HealthCard as JSON, formatted for file downloads
+    # @return [String] JSON string containing file download contents
+    def to_json(*_args)
+      Exporter.file_download([@jws])
     end
 
-    # A compressed version of the FHIR::Bundle based on the SMART Health Cards frame work and any other constraints
-    # defined by a subclass
-    # @return String compressed payload
-    def to_s
-      HealthCard.compress_payload(to_json)
+    # QR Codes representing this HealthCard
+    # @return [Array<Chunk>] an array of QR Code chunks
+    def qr_codes
+      @qr_codes.chunks
     end
 
-    # A minified JSON string matching the VC structure specified by https://smarthealth.cards/#health-cards-are-encoded-as-compact-serialization-json-web-signatures-jws
-    # @return [String] JSON string
-    def to_json(*_args)
-      to_hash.to_json
+    # Extracts a resource from the bundle contained in the HealthCard. A filter
+    # can be applied by using a block. The method will yield each resource to the block.
+    # The block should return a boolean
+    # @param type [Class] :type should be a class representing a FHIR resource
+    # @return The first bundle resource that matches the type and/or block evaluation
+    def resource(type: nil, &block)
+      resources(type: type, &block).first
     end
 
-    # Processes the bundle according to https://smarthealth.cards/#health-cards-are-small and returns
-    # a Hash with equivalent values
-    # @return [Hash] A hash with the same content as the FHIR::Bundle, processed accoding
-    # to SMART Health Cards framework and any constraints created by subclasses
-    def strip_fhir_bundle
-      return [] unless bundle.entry
-
-      new_bundle = duplicate_bundle
-      url_map = redefine_uris(new_bundle)
-
-      new_bundle.entry.each do |entry|
-        entry.each_element do |value, metadata, _|
-          case metadata['type']
-          when 'Reference'
-            value.reference = process_reference(url_map, entry, value)
-          when 'Resource'
-            value.meta = nil unless value.meta&.security
-          end
-
-          handle_allowable(value)
-          handle_disallowable(value)
-        end
+    # Extracts all resources from the bundle contained in the HealthCard. A filter
+    # can be applied by using a block. The method will yield each resource to the block.
+    # The block should return a boolean
+    # @param type [Class] :type should be a class representing a FHIR resource
+    # @return The first bundle resource that matches the type and/or block evaluation
+    def resources(type: nil, &block)
+      all_resources = bundle.entry.map(&:resource)
+      return all_resources unless type || block
+
+      all_resources.filter do |r|
+        resource_matches_criteria(r, type, &block)
       end
-
-      new_bundle
     end
 
     private
 
-    def duplicate_bundle
-      FHIR::Bundle.new(bundle.to_hash)
-    end
-
-    def redefine_uris(bundle)
-      url_map = {}
-      resource_count = 0
-      bundle.entry.each do |entry|
-        old_url = entry.fullUrl
-        new_url = "resource:#{resource_count}"
-        url_map[old_url] = new_url
-        entry.fullUrl = new_url
-        resource_count += 1
+    def resource_matches_criteria(resource, type, &block)
+      of_type = type && resource.is_a?(type)
+      if block && type
+        of_type && yield(resource)
+      elsif !type && block
+        yield(resource)
+      else
+        of_type
       end
-      url_map
-    end
-
-    def process_reference(url_map, entry, ref)
-      entry_url = URI(url_map.key(entry.fullUrl))
-      ref_url = ref.reference
-
-      return unless ref_url
-
-      return url_map[ref_url] if url_map[ref_url]
-
-      fhir_base_url = FHIR_REF_REGEX.match(entry_url.to_s)[1]
-      full_url = URI.join(fhir_base_url, ref_url).to_s
-
-      new_url = url_map[full_url]
-
-      raise InvalidBundleReferenceError, full_url unless new_url
-
-      new_url
     end
   end
 end

data/lib/health_cards/importer.rb

@@ -27,7 +27,7 @@ module HealthCards
     # @return [Hash] Hash containing the JWS payload and verification contents
     private_class_method def self.verify_jws(jws_string)
       jws = JWS.from_jws jws_string
-      result = { payload: HealthCard.decompress_payload(jws.payload) }
+      result = { payload: Payload.decompress_payload(jws.payload) }
       begin
         result[:verified] = Verifier.verify jws
         result[:error_message] = 'Signature Invalid' if result[:verified] == false

data/lib/health_cards/issuer.rb

@@ -16,11 +16,11 @@ module HealthCards
       self.key = key
     end
 
-    # Create a HealthCard from the supplied FHIR bundle
+    # Create a Payload from the supplied FHIR bundle
     #
     # @param bundle [FHIR::Bundle, String] the FHIR bundle used as the Health Card payload
-    # @return [HealthCard::]
-    def create_health_card(bundle, type: HealthCard)
+    # @return [Payload::]
+    def create_payload(bundle, type: Payload)
       type.new(issuer: url, bundle: bundle)
     end
 
@@ -30,11 +30,16 @@ module HealthCards
     # @param type [Class] A subclass of HealthCards::Card that processes the bundle according to a specific IG.
     # Leave blank for default SMART Health Card behavior
     # @return [HealthCards::JWS] An instance of JWS using the payload and signed by the issuer's private key
-    def issue_jws(bundle, type: HealthCard)
-      card = create_health_card(bundle, type: type)
+    def issue_jws(bundle, type: Payload)
+      card = create_payload(bundle, type: type)
       JWS.new(header: jws_header, payload: card.to_s, key: key)
     end
 
+    def issue_health_card(bundle, type: Payload)
+      jws = issue_jws(bundle, type: type)
+      HealthCards::HealthCard.new(jws)
+    end
+
     # Set the private key used for signing issued health cards
     #
     # @param key [HealthCards::PrivateKey, nil] the private key used for signing issued health cards

data/lib/health_cards/jws.rb

@@ -6,12 +6,15 @@ module HealthCards
     class << self
       include Encoding
 
-      # Creates a Card from a JWS
-      # @param jws [String, HealthCards::JWS] the JWS string
+      # Creates a JWS from a String representation, or returns the HealthCards::JWS object
+      # that was passed in
+      # @param jws [String, HealthCards::JWS] the JWS string, or a JWS object
       # @param public_key [HealthCards::PublicKey] the public key associated with the JWS
       # @param key [HealthCards::PrivateKey] the private key associated with the JWS
-      # @return [HealthCards::HealthCard]
+      # @return [HealthCards::JWS] A new JWS object, or the JWS object that was passed in
       def from_jws(jws, public_key: nil, key: nil)
+        return jws if jws.is_a?(HealthCards::JWS) && public_key.nil? && key.nil?
+
         unless jws.is_a?(HealthCards::JWS) || jws.is_a?(String)
           raise ArgumentError,
                 'Expected either a HealthCards::JWS or String'

data/lib/health_cards/key_set.rb

@@ -44,7 +44,7 @@ module HealthCards
     # Retrieves a key from the keyset with a kid
     # that matches the parameter
     # @param kid [String] a Base64 encoded kid from a JWS or Key
-    # @return [HealthCard::Key] a key with a matching kid or nil if not found
+    # @return [Payload::Key] a key with a matching kid or nil if not found
     def find_key(kid)
       @key_map[kid]
     end

data/lib/health_cards/payload.rb

@@ -0,0 +1,216 @@
+# frozen_string_literal: true
+
+require 'zlib'
+require 'uri'
+
+require 'health_cards/attribute_filters'
+require 'health_cards/payload_types'
+
+module HealthCards
+  # A Payload which implements the credential claims specified by https://smarthealth.cards/
+  class Payload
+    include HealthCards::AttributeFilters
+    extend HealthCards::PayloadTypes
+
+    FHIR_REF_REGEX = %r{((http|https)://([A-Za-z0-9\-\\.:%$]*/)+)?(
+      Account|ActivityDefinition|AdverseEvent|AllergyIntolerance|Appointment|AppointmentResponse|AuditEvent|Basic|
+      Binary|BiologicallyDerivedProduct|BodyStructure|Bundle|CapabilityStatement|CarePlan|CareTeam|CatalogEntry|
+      ChargeItem|ChargeItemDefinition|Claim|ClaimResponse|ClinicalImpression|CodeSystem|Communication|
+      CommunicationRequest|CompartmentDefinition|Composition|ConceptMap|Condition|Consent|Contract|Coverage|
+      CoverageEligibilityRequest|CoverageEligibilityResponse|DetectedIssue|Device|DeviceDefinition|DeviceMetric
+      |DeviceRequest|DeviceUseStatement|DiagnosticReport|DocumentManifest|DocumentReference|EffectEvidenceSynthesis|
+      Encounter|Endpoint|EnrollmentRequest|EnrollmentResponse|EpisodeOfCare|EventDefinition|Evidence|EvidenceVariable|
+      ExampleScenario|ExplanationOfBenefit|FamilyMemberHistory|Flag|Goal|GraphDefinition|Group|GuidanceResponse|
+      HealthcareService|ImagingStudy|Immunization|ImmunizationEvaluation|ImmunizationRecommendation|
+      ImplementationGuide|InsurancePlan|Invoice|Library|Linkage|List|Location|Measure|MeasureReport|Media|Medication|
+      MedicationAdministration|MedicationDispense|MedicationKnowledge|MedicationRequest|MedicationStatement|
+      MedicinalProduct|MedicinalProductAuthorization|MedicinalProductContraindication|MedicinalProductIndication|
+      MedicinalProductIngredient|MedicinalProductInteraction|MedicinalProductManufactured|MedicinalProductPackaged|
+      MedicinalProductPharmaceutical|MedicinalProductUndesirableEffect|MessageDefinition|MessageHeader|
+      MolecularSequence|NamingSystem|NutritionOrder|Observation|ObservationDefinition|OperationDefinition|
+      OperationOutcome|Organization|OrganizationAffiliation|Patient|PaymentNotice|PaymentReconciliation|Person|
+      PlanDefinition|Practitioner|PractitionerRole|Procedure|Provenance|Questionnaire|QuestionnaireResponse|
+      RelatedPerson|RequestGroup|ResearchDefinition|ResearchElementDefinition|ResearchStudy|ResearchSubject|
+      RiskAssessment|RiskEvidenceSynthesis|Schedule|SearchParameter|ServiceRequest|Slot|Specimen|SpecimenDefinition|
+      StructureDefinition|StructureMap|Subscription|Substance|SubstanceNucleicAcid|SubstancePolymer|SubstanceProtein|
+      SubstanceReferenceInformation|SubstanceSourceMaterial|SubstanceSpecification|SupplyDelivery|SupplyRequest|Task|
+      TerminologyCapabilities|TestReport|TestScript|ValueSet|VerificationResult|VisionPrescription)/
+      [A-Za-z0-9\-.]{1,64}(/_history/[A-Za-z0-9\-.]{1,64})?}x.freeze
+
+    attr_reader :issuer, :nbf, :bundle
+
+    class << self
+      # Create a Payload from a compressed payload
+      # @param payload [String]
+      # @return [HealthCards::Payload]
+      def from_payload(payload)
+        json = decompress_payload(payload)
+        bundle_hash = json.dig('vc', 'credentialSubject', 'fhirBundle')
+
+        raise HealthCards::InvalidCredentialError unless bundle_hash
+
+        bundle = extract_bundle(payload)
+        new(issuer: json['iss'], bundle: bundle)
+      end
+
+      # Extract a bundle from a compressed payload
+      # @param payload [String]
+      # @return [FHIR::Bundle]
+      def extract_bundle(payload)
+        json = decompress_payload(payload)
+        bundle_hash = json.dig('vc', 'credentialSubject', 'fhirBundle')
+
+        raise HealthCards::InvalidCredentialError unless bundle_hash
+
+        FHIR::Bundle.new(bundle_hash)
+      end
+
+      # Decompress an arbitrary payload, useful for debugging
+      # @param payload [String] compressed payload
+      # @return [Hash] Hash built from JSON contents of payload
+      def decompress_payload(payload)
+        inf = Zlib::Inflate.new(-Zlib::MAX_WBITS).inflate(payload)
+        JSON.parse(inf)
+      end
+
+      # Compress an arbitrary payload, useful for debugging
+      # @param payload [Object] Any object that responds to to_s
+      # @return A compressed version of that payload parameter
+      def compress_payload(payload)
+        Zlib::Deflate.new(nil, -Zlib::MAX_WBITS).deflate(payload.to_s, Zlib::FINISH)
+      end
+
+      # Sets/Gets the fhir version that will be passed through to the credential created by an instnace of
+      # this Payload (sub)class
+      # @param ver [String] FHIR Version supported by this Payload (sub)class. Leaving this param out
+      # will only return the current value
+      # value (used as a getter)
+      # @return [String] Current FHIR version supported
+      def fhir_version(ver = nil)
+        if @fhir_version.nil? && ver.nil?
+          @fhir_version = superclass.fhir_version unless self == HealthCards::Payload
+        elsif ver
+          @fhir_version = ver
+        end
+        @fhir_version
+      end
+    end
+
+    fhir_version '4.0.1'
+
+    additional_types 'https://smarthealth.cards#health-card'
+
+    allow type: FHIR::Meta, attributes: %w[security]
+
+    disallow attributes: %w[id text]
+    disallow type: FHIR::CodeableConcept, attributes: %w[text]
+    disallow type: FHIR::Coding, attributes: %w[display]
+
+    # Create a Payload
+    #
+    # @param bundle [FHIR::Bundle] VerifiableCredential containing a fhir bundle
+    # @param issuer [String] The url from the Issuer of the Payload
+    def initialize(bundle:, issuer: nil)
+      raise InvalidPayloadError unless bundle.is_a?(FHIR::Bundle) # && bundle.valid?
+
+      @issuer = issuer
+      @bundle = bundle
+    end
+
+    # A Hash matching the VC structure specified by https://smarthealth.cards/#health-cards-are-encoded-as-compact-serialization-json-web-signatures-jws
+    # @param filter [Boolean] specifies whether the bundle should apply allow/disallow rules
+    #  and meta filtering features. Defaults to true.
+    # @return [Hash]
+    def to_hash(filter: true)
+      fhir_bundle = filter ? strip_fhir_bundle : bundle
+      {
+        iss: issuer,
+        nbf: Time.now.to_i,
+        vc: {
+          type: self.class.types,
+          credentialSubject: {
+            fhirVersion: self.class.fhir_version,
+            fhirBundle: fhir_bundle.to_hash
+          }
+        }
+      }
+    end
+
+    # A compressed version of the FHIR::Bundle based on the SMART Health Cards frame work and any other constraints
+    # defined by a subclass
+    # @return String compressed payload
+    def to_s
+      Payload.compress_payload(to_json)
+    end
+
+    # A minified JSON string matching the VC structure specified by https://smarthealth.cards/#health-cards-are-encoded-as-compact-serialization-json-web-signatures-jws
+    # @return [String] JSON string
+    def to_json(*args)
+      to_hash.to_json(*args)
+    end
+
+    # Processes the bundle according to https://smarthealth.cards/#health-cards-are-small and returns
+    # a Hash with equivalent values
+    # @return [Hash] A hash with the same content as the FHIR::Bundle, processed accoding
+    # to SMART Health Cards framework and any constraints created by subclasses
+    def strip_fhir_bundle
+      return [] unless bundle.entry
+
+      new_bundle = duplicate_bundle
+      url_map = redefine_uris(new_bundle)
+
+      new_bundle.entry.each do |entry|
+        entry.each_element do |value, metadata, _|
+          case metadata['type']
+          when 'Reference'
+            value.reference = process_reference(url_map, entry, value)
+          when 'Resource'
+            value.meta = nil unless value.meta&.security
+          end
+
+          handle_allowable(value)
+          handle_disallowable(value)
+        end
+      end
+
+      new_bundle
+    end
+
+    private
+
+    def duplicate_bundle
+      FHIR::Bundle.new(bundle.to_hash)
+    end
+
+    def redefine_uris(bundle)
+      url_map = {}
+      resource_count = 0
+      bundle.entry.each do |entry|
+        old_url = entry.fullUrl
+        new_url = "resource:#{resource_count}"
+        url_map[old_url] = new_url
+        entry.fullUrl = new_url
+        resource_count += 1
+      end
+      url_map
+    end
+
+    def process_reference(url_map, entry, ref)
+      entry_url = URI(url_map.key(entry.fullUrl))
+      ref_url = ref.reference
+
+      return unless ref_url
+
+      return url_map[ref_url] if url_map[ref_url]
+
+      fhir_base_url = FHIR_REF_REGEX.match(entry_url.to_s)[1]
+      full_url = URI.join(fhir_base_url, ref_url).to_s
+
+      new_url = url_map[full_url]
+
+      raise InvalidBundleReferenceError, full_url unless new_url
+
+      new_url
+    end
+  end
+end

data/lib/health_cards/payload_types/covid_immunization_payload.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module HealthCards
+  class COVIDImmunizationPayload < COVIDPayload
+    additional_types 'https://smarthealth.cards#immunization'
+
+    allow type: FHIR::Immunization,
+          attributes: %w[meta status vaccineCode patient occurrenceDateTime manufacturer lotNumber performer
+                         isSubpotent]
+  end
+end

data/lib/health_cards/payload_types/covid_lab_result_payload.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module HealthCards
+  class COVIDLabResultPayload < COVIDPayload
+    additional_types 'https://smarthealth.cards#laboratory'
+
+    allow type: FHIR::Observation,
+          attributes: %w[meta status code subject effectiveDateTime effectivePeriod performer
+                         valueCodeableConcept valueQuantity valueString referenceRange]
+  end
+end

data/lib/health_cards/payload_types/covid_payload.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'health_cards/attribute_filters'
+require 'health_cards/payload_types'
+
+module HealthCards
+  # Implements Payload for use with COVID Vaccination IG
+  class COVIDPayload < HealthCards::Payload
+    additional_types 'https://smarthealth.cards#covid19'
+
+    allow type: FHIR::Patient, attributes: %w[identifier name birthDate]
+  end
+end

data/lib/health_cards/{card_types.rb → payload_types.rb}

@@ -1,30 +1,27 @@
 # frozen_string_literal: true
 
 module HealthCards
-  # Handles behavior related to support types by Healthcard subclasses
-  module CardTypes
-    VC_TYPE = [
-      'https://smarthealth.cards#health-card'
-    ].freeze
-
-    # Additional type claims this HealthCard class supports
+  # Handles behavior related to support types by Payload subclasses
+  module PayloadTypes
+    # Additional type claims this Payload class supports
     # @param types [String, Array] A string or array of string representing the additional type claims or nil
     # if used as a getter
     # @return [Array] the additional types added by this classes
     def additional_types(*add_types)
-      types.concat(add_types) unless add_types.nil?
-      types - VC_TYPE
+      @additional_types ||= []
+      @additional_types.concat(add_types) unless add_types.nil?
+      @additional_types
     end
 
-    # Type claims supported by this HealthCard subclass
+    # Type claims supported by this Payload subclass
     # @return [Array] an array of Strings with all the supported type claims
     def types
-      @types ||= VC_TYPE.dup
+      @types ||= self == HealthCards::Payload ? additional_types : superclass.types + additional_types
     end
 
     # Check if this class supports the given type claim(s)
     # @param type [Array, String] A type as defined by the SMART Health Cards framework
-    # @return [Boolean] Whether or not the type param is included in the types supported by the HealthCard (sub)class
+    # @return [Boolean] Whether or not the type param is included in the types supported by the Payload (sub)class
     def supports_type?(*type)
       !types.intersection(type.flatten).empty?
     end

data/lib/health_cards/verification.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module HealthCards
-  # Logic for verifying a HealthCard JWS
+  # Logic for verifying a Payload JWS
   module Verification
     # Verify Health Card with given KeySet
     #
@@ -10,7 +10,7 @@ module HealthCards
     # @param resolve_keys [Boolean] if keys should be resolved
     # @return [Boolean]
     def verify_using_key_set(verifiable, key_set = nil, resolve_keys: true)
-      jws = JWS.from_jws(verifiable)
+      jws = verifiable.is_a?(HealthCards::HealthCard) ? verifiable.jws : JWS.from_jws(verifiable)
       key_set ||= HealthCards::KeySet.new
       key_set.add_keys(resolve_key(jws)) if resolve_keys && key_set.find_key(jws.kid).nil?
 
@@ -28,7 +28,7 @@ module HealthCards
     # @param jws [HealthCards::JWS, String] The JWS for which to resolve keys
     # @return [HealthCards::KeySet]
     def resolve_key(jws)
-      jwks_uri = URI("#{HealthCard.from_jws(jws.to_s).issuer}/.well-known/jwks.json")
+      jwks_uri = URI("#{HealthCard.new(jws.to_s).issuer}/.well-known/jwks.json")
       res = Net::HTTP.get(jwks_uri)
       HealthCards::KeySet.from_jwks(res)
     # Handle response if key is malformed or unreachable

data/lib/health_cards/verifier.rb

@@ -12,7 +12,7 @@ module HealthCards
     include HealthCards::Verification
     extend HealthCards::Verification
 
-    # Verify a HealthCard
+    # Verify a Payload
     #
     # This method _always_ uses key resolution and does not depend on any cached keys
     #
@@ -53,7 +53,7 @@ module HealthCards
       @keys.remove_keys(key)
     end
 
-    # Verify a HealthCard
+    # Verify a Payload
     #
     # @param verifiable [HealthCards::JWS, String] the health card to verify
     # @return [Boolean]

data/lib/health_cards/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HealthCards
-  VERSION = '0.0.2'
+  VERSION = '1.0.0'
 end

data/lib/health_cards.rb

@@ -9,15 +9,18 @@ require 'health_cards/key_set'
 require 'health_cards/private_key'
 require 'health_cards/public_key'
 require 'health_cards/health_card'
+require 'health_cards/payload'
 require 'health_cards/attribute_filters'
-require 'health_cards/card_types'
+require 'health_cards/payload_types'
 require 'health_cards/chunking_utils'
 require 'health_cards/errors'
 require 'health_cards/qr_codes'
 require 'health_cards/chunk'
 require 'health_cards/verifier'
 require 'health_cards/importer'
-require 'health_cards/covid_health_card'
+require 'health_cards/payload_types/covid_payload'
+require 'health_cards/payload_types/covid_immunization_payload'
+require 'health_cards/payload_types/covid_lab_result_payload'
 require 'health_cards/exporter'
 
 require 'base64'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: health_cards
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Reece Adamson
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-09 00:00:00.000000000 Z
+date: 2021-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fhir_models
@@ -45,14 +45,28 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rqrcode_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
 description: "Health Cards implements SMART Health Cards, a secure and decentralized
   framework that allows \npeople to prove their vaccination status or medical test
-  results. It is built on top of FHIR R4 \nhealth data exchange standards and W3C
-  Verifiable Credentials. It allows conversion of\nclinical data into JWS which may
-  then be embedded into QR codes, exported to smart-health-card files, or\nreturned
-  by a $health-card-issue FHIR operation.\n"
+  results. It is based off of W3C \nVerifiable Credentials and FHIR R4 health data
+  exchange standards. It allows conversion of \nclinical data into JWS which may then
+  be embedded into QR codes, exported to smart-health-card \nfiles, or returned by
+  a $health-card-issue FHIR operation.\n"
 email:
-- radamson@mitre.org
+- vci-developers@mitre.org
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -60,10 +74,8 @@ files:
 - LICENSE.txt
 - lib/health_cards.rb
 - lib/health_cards/attribute_filters.rb
-- lib/health_cards/card_types.rb
 - lib/health_cards/chunk.rb
 - lib/health_cards/chunking_utils.rb
-- lib/health_cards/covid_health_card.rb
 - lib/health_cards/encoding.rb
 - lib/health_cards/errors.rb
 - lib/health_cards/exporter.rb
@@ -73,19 +85,24 @@ files:
 - lib/health_cards/jws.rb
 - lib/health_cards/key.rb
 - lib/health_cards/key_set.rb
+- lib/health_cards/payload.rb
+- lib/health_cards/payload_types.rb
+- lib/health_cards/payload_types/covid_immunization_payload.rb
+- lib/health_cards/payload_types/covid_lab_result_payload.rb
+- lib/health_cards/payload_types/covid_payload.rb
 - lib/health_cards/private_key.rb
 - lib/health_cards/public_key.rb
 - lib/health_cards/qr_codes.rb
 - lib/health_cards/verification.rb
 - lib/health_cards/verifier.rb
 - lib/health_cards/version.rb
-homepage: https://github.com/dvci/health-cards
+homepage: https://github.com/dvci/health_cards
 licenses:
 - Apache-2.0
 metadata:
-  homepage_uri: https://github.com/dvci/health-cards
+  homepage_uri: https://github.com/dvci/health_cards
   source_code_uri: https://github.com/dvci/health_cards
-  changelog_uri: https://github.com/dvci/health_cards/CHANGELOG.md
+  changelog_uri: https://github.com/dvci/health_cards/blob/main/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:

data/lib/health_cards/covid_health_card.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require 'health_cards/attribute_filters'
-require 'health_cards/card_types'
-
-module HealthCards
-  # Implements HealthCard for use with COVID Vaccination IG
-  class COVIDHealthCard < HealthCards::HealthCard
-    fhir_version '4.0.1'
-
-    additional_types 'https://smarthealth.cards#covid19'
-    additional_types 'https://smarthealth.cards#immunization'
-
-    allow type: FHIR::Patient, attributes: %w[name birthDate]
-    allow type: FHIR::Immunization, attributes: %w[status vaccineCode patient occurrenceDateTime]
-  end
-end