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

// Auto-generated from StructureDefinition for Provenance.
// Who, What, When for a set of resources.
// See http://hl7.org/fhir/StructureDefinition/Provenance
message Provenance {
  option (.google.fhir.proto.structure_definition_kind) = KIND_RESOURCE;
  option (.google.fhir.proto.fhir_structure_definition_url) =
      "http://hl7.org/fhir/StructureDefinition/Provenance";

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

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

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

  // Target Reference(s) (usually version specific)
  repeated Reference target = 10 [
    (.google.fhir.proto.validation_requirement) = REQUIRED_BY_FHIR,
    (.google.fhir.proto.valid_reference_type) = "Resource"
  ];

  // When the activity occurred
  message OccurredX {
    option (.google.fhir.proto.is_choice_type) = true;

    oneof choice {
      Period period = 1;
      DateTime date_time = 2;
    }
  }
  OccurredX occurred = 11;

  // When the activity was recorded / updated
  Instant recorded = 12
      [(.google.fhir.proto.validation_requirement) = REQUIRED_BY_FHIR];

  // Policy or plan the activity was defined by
  repeated Uri policy = 13;

  // Where the activity occurred, if relevant
  Reference location = 14
      [(.google.fhir.proto.valid_reference_type) = "Location"];

  // Reason the activity is occurring
  repeated CodeableConcept reason = 15;

  // Activity that occurred
  CodeableConcept activity = 16;

  // Actor involved
  message Agent {
    // 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;

    // How the agent participated
    CodeableConcept type = 4;

    // What the agents role was
    repeated CodeableConcept role = 5;

    // Who participated
    Reference who = 6 [
      (.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) = "RelatedPerson",
      (.google.fhir.proto.valid_reference_type) = "Patient",
      (.google.fhir.proto.valid_reference_type) = "Device",
      (.google.fhir.proto.valid_reference_type) = "Organization"
    ];

    // Who the agent is representing
    Reference on_behalf_of = 7 [
      (.google.fhir.proto.valid_reference_type) = "Practitioner",
      (.google.fhir.proto.valid_reference_type) = "PractitionerRole",
      (.google.fhir.proto.valid_reference_type) = "RelatedPerson",
      (.google.fhir.proto.valid_reference_type) = "Patient",
      (.google.fhir.proto.valid_reference_type) = "Device",
      (.google.fhir.proto.valid_reference_type) = "Organization"
    ];
  }
  repeated Agent agent = 17
      [(.google.fhir.proto.validation_requirement) = REQUIRED_BY_FHIR];

  // An entity used in this activity
  message Entity {
    // 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;

    // derivation | revision | quotation | source | removal
    message RoleCode {
      option (.google.fhir.proto.structure_definition_kind) =
          KIND_PRIMITIVE_TYPE;
      option (.google.fhir.proto.fhir_valueset_url) =
          "http://hl7.org/fhir/ValueSet/provenance-entity-role";
      option (.google.fhir.proto.fhir_profile_base) =
          "http://hl7.org/fhir/StructureDefinition/code";

      ProvenanceEntityRoleCode.Value value = 1;

      String id = 2;

      repeated Extension extension = 3;
    }
    RoleCode role = 4
        [(.google.fhir.proto.validation_requirement) = REQUIRED_BY_FHIR];

    // Identity of entity
    Reference what = 5 [
      (.google.fhir.proto.validation_requirement) = REQUIRED_BY_FHIR,
      (.google.fhir.proto.valid_reference_type) = "Resource"
    ];

    // Entity is attributed to this agent
    repeated Agent agent = 6;
  }
  repeated Entity entity = 18;

  // Signature on target
  repeated Signature signature = 19;
}
