//    Copyright 2019 Google Inc.
//
//    Licensed under the Apache License, Version 2.0 (the "License");
//    you may not use this file except in compliance with the License.
//    You may obtain a copy of the License at
//
//        https://www.apache.org/licenses/LICENSE-2.0
//
//    Unless required by applicable law or agreed to in writing, software
//    distributed under the License is distributed on an "AS IS" BASIS,
//    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//    See the License for the specific language governing permissions and
//    limitations under the License.

syntax = "proto3";

package google.fhir.r4.core;

import "google/protobuf/any.proto";
import "google/fhir/core/proto/annotations.proto";
import "google/fhir/r4/proto/core/codes.proto";
import "google/fhir/r4/proto/core/datatypes.proto";

option java_multiple_files = true;
option java_package = "com.google.fhir.r4.core";
option (.google.fhir.proto.fhir_version) = R4;
option go_package = "github.com/google/fhir/go/google/fhir/r4/proto/core/resources/coverage_go_proto";

// Auto-generated from StructureDefinition for Coverage.
// Insurance or medical plan or a payment agreement.
// See http://hl7.org/fhir/StructureDefinition/Coverage
message Coverage {
  option (.google.fhir.proto.structure_definition_kind) = KIND_RESOURCE;
  option (.google.fhir.proto.fhir_structure_definition_url) =
      "http://hl7.org/fhir/StructureDefinition/Coverage";

  // Logical id of this artifact
  Id id = 1;

  // Metadata about the resource
  Meta meta = 2;

  // A set of rules under which this content was created
  Uri implicit_rules = 3;

  // Language of the resource content
  Code language = 4;

  // Text summary of the resource, for human interpretation
  Narrative text = 5;

  // Contained, inline Resources
  repeated protobuf.Any contained = 6;

  // Field 7 reserved for strongly-typed ContainedResource for id:
  // Coverage.contained
  reserved 7;

  // Additional content defined by implementations
  repeated Extension extension = 8;

  // Extensions that cannot be ignored
  repeated Extension modifier_extension = 9;

  // Business Identifier for the coverage
  repeated Identifier identifier = 10;

  // active | cancelled | draft | entered-in-error
  message StatusCode {
    option (.google.fhir.proto.structure_definition_kind) = KIND_PRIMITIVE_TYPE;
    option (.google.fhir.proto.fhir_valueset_url) =
        "http://hl7.org/fhir/ValueSet/fm-status";
    option (.google.fhir.proto.fhir_profile_base) =
        "http://hl7.org/fhir/StructureDefinition/code";

    FinancialResourceStatusCode.Value value = 1;

    String id = 2;

    repeated Extension extension = 3;
  }
  StatusCode status = 11
      [(.google.fhir.proto.validation_requirement) = REQUIRED_BY_FHIR];

  // Coverage category such as medical or accident
  CodeableConcept type = 12;

  // Owner of the policy
  Reference policy_holder = 13 [
    (.google.fhir.proto.valid_reference_type) = "Patient",
    (.google.fhir.proto.valid_reference_type) = "RelatedPerson",
    (.google.fhir.proto.valid_reference_type) = "Organization"
  ];

  // Subscriber to the policy
  Reference subscriber = 14 [
    (.google.fhir.proto.valid_reference_type) = "Patient",
    (.google.fhir.proto.valid_reference_type) = "RelatedPerson"
  ];

  // ID assigned to the subscriber
  String subscriber_id = 15;

  // Plan beneficiary
  Reference beneficiary = 16 [
    (.google.fhir.proto.validation_requirement) = REQUIRED_BY_FHIR,
    (.google.fhir.proto.valid_reference_type) = "Patient"
  ];

  // Dependent number
  String dependent = 17;

  // Beneficiary relationship to the subscriber
  CodeableConcept relationship = 18;

  // Coverage start and end dates
  Period period = 19;

  // Issuer of the policy
  repeated Reference payor = 20 [
    (.google.fhir.proto.validation_requirement) = REQUIRED_BY_FHIR,
    (.google.fhir.proto.valid_reference_type) = "Organization",
    (.google.fhir.proto.valid_reference_type) = "Patient",
    (.google.fhir.proto.valid_reference_type) = "RelatedPerson"
  ];

  // Additional coverage classifications
  message Class {
    // Unique id for inter-element referencing
    String id = 1;

    // Additional content defined by implementations
    repeated Extension extension = 2;

    // Extensions that cannot be ignored even if unrecognized
    repeated Extension modifier_extension = 3;

    // Type of class such as 'group' or 'plan'
    CodeableConcept type = 4
        [(.google.fhir.proto.validation_requirement) = REQUIRED_BY_FHIR];

    // Value associated with the type
    String value = 5
        [(.google.fhir.proto.validation_requirement) = REQUIRED_BY_FHIR];

    // Human readable description of the type and value
    String name = 6;
  }
  repeated Class class_value = 21 [json_name = "class"];

  // Relative order of the coverage
  PositiveInt order = 22;

  // Insurer network
  String network = 23;

  // Patient payments for services/products
  message CostToBeneficiary {
    // Unique id for inter-element referencing
    String id = 1;

    // Additional content defined by implementations
    repeated Extension extension = 2;

    // Extensions that cannot be ignored even if unrecognized
    repeated Extension modifier_extension = 3;

    // Cost category
    CodeableConcept type = 4;

    // The amount or percentage due from the beneficiary
    message ValueX {
      option (.google.fhir.proto.is_choice_type) = true;

      oneof choice {
        SimpleQuantity quantity = 1;
        Money money = 2;
      }
    }
    ValueX value = 5
        [(.google.fhir.proto.validation_requirement) = REQUIRED_BY_FHIR];

    // Exceptions for patient payments
    message Exemption {
      // Unique id for inter-element referencing
      String id = 1;

      // Additional content defined by implementations
      repeated Extension extension = 2;

      // Extensions that cannot be ignored even if unrecognized
      repeated Extension modifier_extension = 3;

      // Exception category
      CodeableConcept type = 4
          [(.google.fhir.proto.validation_requirement) = REQUIRED_BY_FHIR];

      // The effective period of the exception
      Period period = 5;
    }
    repeated Exemption exception = 6;
  }
  repeated CostToBeneficiary cost_to_beneficiary = 24;

  // Reimbursement to insurer
  Boolean subrogation = 25;

  // Contract details
  repeated Reference contract = 26
      [(.google.fhir.proto.valid_reference_type) = "Contract"];
}
