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

// Auto-generated from StructureDefinition for GuidanceResponse.
// The formal response to a guidance request.
// See http://hl7.org/fhir/StructureDefinition/GuidanceResponse
message GuidanceResponse {
  option (.google.fhir.proto.structure_definition_kind) = KIND_RESOURCE;
  option (.google.fhir.proto.fhir_structure_definition_url) =
      "http://hl7.org/fhir/StructureDefinition/GuidanceResponse";

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

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

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

  // The identifier of the request associated with this response, if any
  Identifier request_identifier = 10;

  // Business identifier
  repeated Identifier identifier = 11;

  // What guidance was requested
  message ModuleX {
    option (.google.fhir.proto.is_choice_type) = true;

    oneof choice {
      Uri uri = 1;
      Canonical canonical = 2;
      CodeableConcept codeable_concept = 3;
    }
  }
  ModuleX module = 12
      [(.google.fhir.proto.validation_requirement) = REQUIRED_BY_FHIR];

  // success | data-requested | data-required | in-progress | failure |
  // 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/guidance-response-status";
    option (.google.fhir.proto.fhir_profile_base) =
        "http://hl7.org/fhir/StructureDefinition/code";

    GuidanceResponseStatusCode.Value value = 1;

    String id = 2;

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

  // Patient the request was performed for
  Reference subject = 14 [
    (.google.fhir.proto.valid_reference_type) = "Patient",
    (.google.fhir.proto.valid_reference_type) = "Group"
  ];

  // Encounter during which the response was returned
  Reference encounter = 15
      [(.google.fhir.proto.valid_reference_type) = "Encounter"];

  // When the guidance response was processed
  DateTime occurrence_date_time = 16;

  // Device returning the guidance
  Reference performer = 17
      [(.google.fhir.proto.valid_reference_type) = "Device"];

  // Why guidance is needed
  repeated CodeableConcept reason_code = 18;

  // Why guidance is needed
  repeated Reference reason_reference = 19 [
    (.google.fhir.proto.valid_reference_type) = "Condition",
    (.google.fhir.proto.valid_reference_type) = "Observation",
    (.google.fhir.proto.valid_reference_type) = "DiagnosticReport",
    (.google.fhir.proto.valid_reference_type) = "DocumentReference"
  ];

  // Additional notes about the response
  repeated Annotation note = 20;

  // Messages resulting from the evaluation of the artifact or artifacts
  repeated Reference evaluation_message = 21
      [(.google.fhir.proto.valid_reference_type) = "OperationOutcome"];

  // The output parameters of the evaluation, if any
  Reference output_parameters = 22
      [(.google.fhir.proto.valid_reference_type) = "Parameters"];

  // Proposed actions, if any
  Reference result = 23 [
    (.google.fhir.proto.valid_reference_type) = "CarePlan",
    (.google.fhir.proto.valid_reference_type) = "RequestGroup"
  ];

  // Additional required data
  repeated DataRequirement data_requirement = 24;
}
