//    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/datatypes.proto";
import "google/fhir/r4/proto/core/valuesets.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/immunization_go_proto";

// Auto-generated from StructureDefinition for Immunization.
// Immunization event information.
// See http://hl7.org/fhir/StructureDefinition/Immunization
message Immunization {
  option (.google.fhir.proto.structure_definition_kind) = KIND_RESOURCE;
  option (.google.fhir.proto.fhir_structure_definition_url) =
      "http://hl7.org/fhir/StructureDefinition/Immunization";

  // 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:
  // Immunization.contained
  reserved 7;

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

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

  // Business identifier
  repeated Identifier identifier = 10;

  // completed | entered-in-error | not-done
  message StatusCode {
    option (.google.fhir.proto.structure_definition_kind) = KIND_PRIMITIVE_TYPE;
    option (.google.fhir.proto.fhir_valueset_url) =
        "http://hl7.org/fhir/ValueSet/immunization-status";
    option (.google.fhir.proto.fhir_profile_base) =
        "http://hl7.org/fhir/StructureDefinition/code";

    ImmunizationStatusCodesValueSet.Value value = 1;

    String id = 2;

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

  // Reason not done
  CodeableConcept status_reason = 12;

  // Vaccine product administered
  CodeableConcept vaccine_code = 13
      [(.google.fhir.proto.validation_requirement) = REQUIRED_BY_FHIR];

  // Who was immunized
  Reference patient = 14 [
    (.google.fhir.proto.validation_requirement) = REQUIRED_BY_FHIR,
    (.google.fhir.proto.valid_reference_type) = "Patient"
  ];

  // Encounter immunization was part of
  Reference encounter = 15
      [(.google.fhir.proto.valid_reference_type) = "Encounter"];

  // Vaccine administration date
  message OccurrenceX {
    option (.google.fhir.proto.is_choice_type) = true;

    oneof choice {
      DateTime date_time = 1;
      String string_value = 2 [json_name = "string"];
    }
  }
  OccurrenceX occurrence = 16
      [(.google.fhir.proto.validation_requirement) = REQUIRED_BY_FHIR];

  // When the immunization was first captured in the subject's record
  DateTime recorded = 17;

  // Indicates context the data was recorded in
  Boolean primary_source = 18;

  // Indicates the source of a secondarily reported record
  CodeableConcept report_origin = 19;

  // Where immunization occurred
  Reference location = 20
      [(.google.fhir.proto.valid_reference_type) = "Location"];

  // Vaccine manufacturer
  Reference manufacturer = 21
      [(.google.fhir.proto.valid_reference_type) = "Organization"];

  // Vaccine lot number
  String lot_number = 22;

  // Vaccine expiration date
  Date expiration_date = 23;

  // Body site vaccine  was administered
  CodeableConcept site = 24;

  // How vaccine entered body
  CodeableConcept route = 25;

  // Amount of vaccine administered
  SimpleQuantity dose_quantity = 26;

  // Who performed event
  message Performer {
    // 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;

    // What type of performance was done
    CodeableConcept function = 4;

    // Individual or organization who was performing
    Reference actor = 5 [
      (.google.fhir.proto.validation_requirement) = REQUIRED_BY_FHIR,
      (.google.fhir.proto.valid_reference_type) = "Practitioner",
      (.google.fhir.proto.valid_reference_type) = "PractitionerRole",
      (.google.fhir.proto.valid_reference_type) = "Organization"
    ];
  }
  repeated Performer performer = 27;

  // Additional immunization notes
  repeated Annotation note = 28;

  // Why immunization occurred
  repeated CodeableConcept reason_code = 29;

  // Why immunization occurred
  repeated Reference reason_reference = 30 [
    (.google.fhir.proto.valid_reference_type) = "Condition",
    (.google.fhir.proto.valid_reference_type) = "Observation",
    (.google.fhir.proto.valid_reference_type) = "DiagnosticReport"
  ];

  // Dose potency
  Boolean is_subpotent = 31;

  // Reason for being subpotent
  repeated CodeableConcept subpotent_reason = 32;

  // Educational material presented to patient
  message Education {
    option (.google.fhir.proto.fhir_path_message_constraint) =
        "documentType.exists() or reference.exists()";

    // 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;

    // Educational material document identifier
    String document_type = 4;

    // Educational material reference pointer
    Uri reference = 5;

    // Educational material publication date
    DateTime publication_date = 6;

    // Educational material presentation date
    DateTime presentation_date = 7;
  }
  repeated Education education = 33;

  // Patient eligibility for a vaccination program
  repeated CodeableConcept program_eligibility = 34;

  // Funding source for the vaccine
  CodeableConcept funding_source = 35;

  // Details of a reaction that follows immunization
  message Reaction {
    // 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;

    // When reaction started
    DateTime date = 4;

    // Additional information on reaction
    Reference detail = 5
        [(.google.fhir.proto.valid_reference_type) = "Observation"];

    // Indicates self-reported reaction
    Boolean reported = 6;
  }
  repeated Reaction reaction = 36;

  // Protocol followed by the provider
  message ProtocolApplied {
    // 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;

    // Name of vaccine series
    String series = 4;

    // Who is responsible for publishing the recommendations
    Reference authority = 5
        [(.google.fhir.proto.valid_reference_type) = "Organization"];

    // Vaccine preventatable disease being targetted
    repeated CodeableConcept target_disease = 6;

    // Dose number within series
    message DoseNumberX {
      option (.google.fhir.proto.is_choice_type) = true;

      oneof choice {
        PositiveInt positive_int = 1;
        String string_value = 2 [json_name = "string"];
      }
    }
    DoseNumberX dose_number = 7
        [(.google.fhir.proto.validation_requirement) = REQUIRED_BY_FHIR];

    // Recommended number of doses for immunity
    message SeriesDosesX {
      option (.google.fhir.proto.is_choice_type) = true;

      oneof choice {
        PositiveInt positive_int = 1;
        String string_value = 2 [json_name = "string"];
      }
    }
    SeriesDosesX series_doses = 8;
  }
  repeated ProtocolApplied protocol_applied = 37;
}
