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

// Auto-generated from StructureDefinition for ResearchElementDefinition.
// A population, intervention, or exposure definition.
// See http://hl7.org/fhir/StructureDefinition/ResearchElementDefinition
message ResearchElementDefinition {
  option (.google.fhir.proto.structure_definition_kind) = KIND_RESOURCE;
  option (.google.fhir.proto.fhir_structure_definition_url) =
      "http://hl7.org/fhir/StructureDefinition/ResearchElementDefinition";
  option (.google.fhir.proto.fhir_path_message_warning_constraint) =
      "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')";

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

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

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

  // Canonical identifier for this research element definition, represented as a
  // URI (globally unique)
  Uri url = 10;

  // Additional identifier for the research element definition
  repeated Identifier identifier = 11;

  // Business version of the research element definition
  String version = 12;

  // Name for this research element definition (computer friendly)
  String name = 13;

  // Name for this research element definition (human friendly)
  String title = 14;

  // Title for use in informal contexts
  String short_title = 15;

  // Subordinate title of the ResearchElementDefinition
  String subtitle = 16;

  // draft | active | retired | unknown
  message StatusCode {
    option (.google.fhir.proto.structure_definition_kind) = KIND_PRIMITIVE_TYPE;
    option (.google.fhir.proto.fhir_valueset_url) =
        "http://hl7.org/fhir/ValueSet/publication-status";
    option (.google.fhir.proto.fhir_profile_base) =
        "http://hl7.org/fhir/StructureDefinition/code";

    PublicationStatusCode.Value value = 1;

    String id = 2;

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

  // For testing purposes, not real usage
  Boolean experimental = 18;

  // E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
  message SubjectX {
    option (.google.fhir.proto.is_choice_type) = true;

    oneof choice {
      CodeableConcept codeable_concept = 1;
      Reference reference = 2
          [(.google.fhir.proto.valid_reference_type) = "Group"];
    }
  }
  SubjectX subject = 19;

  // Date last changed
  DateTime date = 20;

  // Name of the publisher (organization or individual)
  String publisher = 21;

  // Contact details for the publisher
  repeated ContactDetail contact = 22;

  // Natural language description of the research element definition
  Markdown description = 23;

  // Used for footnotes or explanatory notes
  repeated String comment = 24;

  // The context that the content is intended to support
  repeated UsageContext use_context = 25;

  // Intended jurisdiction for research element definition (if applicable)
  repeated CodeableConcept jurisdiction = 26;

  // Why this research element definition is defined
  Markdown purpose = 27;

  // Describes the clinical usage of the ResearchElementDefinition
  String usage = 28;

  // Use and/or publishing restrictions
  Markdown copyright = 29;

  // When the research element definition was approved by publisher
  Date approval_date = 30;

  // When the research element definition was last reviewed
  Date last_review_date = 31;

  // When the research element definition is expected to be used
  Period effective_period = 32;

  // The category of the ResearchElementDefinition, such as Education,
  // Treatment, Assessment, etc.
  repeated CodeableConcept topic = 33;

  // Who authored the content
  repeated ContactDetail author = 34;

  // Who edited the content
  repeated ContactDetail editor = 35;

  // Who reviewed the content
  repeated ContactDetail reviewer = 36;

  // Who endorsed the content
  repeated ContactDetail endorser = 37;

  // Additional documentation, citations, etc.
  repeated RelatedArtifact related_artifact = 38;

  // Logic used by the ResearchElementDefinition
  repeated Canonical library = 39;

  // population | exposure | outcome
  message TypeCode {
    option (.google.fhir.proto.structure_definition_kind) = KIND_PRIMITIVE_TYPE;
    option (.google.fhir.proto.fhir_valueset_url) =
        "http://hl7.org/fhir/ValueSet/research-element-type";
    option (.google.fhir.proto.fhir_profile_base) =
        "http://hl7.org/fhir/StructureDefinition/code";

    ResearchElementTypeCode.Value value = 1;

    String id = 2;

    repeated Extension extension = 3;
  }
  TypeCode type = 40
      [(.google.fhir.proto.validation_requirement) = REQUIRED_BY_FHIR];

  // dichotomous | continuous | descriptive
  message VariableTypeCode {
    option (.google.fhir.proto.structure_definition_kind) = KIND_PRIMITIVE_TYPE;
    option (.google.fhir.proto.fhir_valueset_url) =
        "http://hl7.org/fhir/ValueSet/variable-type";
    option (.google.fhir.proto.fhir_profile_base) =
        "http://hl7.org/fhir/StructureDefinition/code";

    EvidenceVariableTypeCode.Value value = 1;

    String id = 2;

    repeated Extension extension = 3;
  }
  VariableTypeCode variable_type = 41;

  // What defines the members of the research element
  message Characteristic {
    // 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 code or expression defines members?
    message DefinitionX {
      option (.google.fhir.proto.is_choice_type) = true;

      oneof choice {
        CodeableConcept codeable_concept = 1;
        Canonical canonical = 2;
        Expression expression = 3;
        DataRequirement data_requirement = 4;
      }
    }
    DefinitionX definition = 4
        [(.google.fhir.proto.validation_requirement) = REQUIRED_BY_FHIR];

    // What code/value pairs define members?
    repeated UsageContext usage_context = 5;

    // Whether the characteristic includes or excludes members
    Boolean exclude = 6;

    // What unit is the outcome described in?
    CodeableConcept unit_of_measure = 7;

    // What time period does the study cover
    String study_effective_description = 8;

    // What time period does the study cover
    message StudyEffectiveX {
      option (.google.fhir.proto.is_choice_type) = true;

      oneof choice {
        DateTime date_time = 1;
        Period period = 2;
        Duration duration = 3;
        Timing timing = 4;
      }
    }
    StudyEffectiveX study_effective = 9;

    // Observation time from study start
    Duration study_effective_time_from_start = 10;

    // mean | median | mean-of-mean | mean-of-median | median-of-mean |
    // median-of-median
    message StudyEffectiveGroupMeasureCode {
      option (.google.fhir.proto.structure_definition_kind) =
          KIND_PRIMITIVE_TYPE;
      option (.google.fhir.proto.fhir_valueset_url) =
          "http://hl7.org/fhir/ValueSet/group-measure";
      option (.google.fhir.proto.fhir_profile_base) =
          "http://hl7.org/fhir/StructureDefinition/code";

      GroupMeasureCode.Value value = 1;

      String id = 2;

      repeated Extension extension = 3;
    }
    StudyEffectiveGroupMeasureCode study_effective_group_measure = 11;

    // What time period do participants cover
    String participant_effective_description = 12;

    // What time period do participants cover
    message ParticipantEffectiveX {
      option (.google.fhir.proto.is_choice_type) = true;

      oneof choice {
        DateTime date_time = 1;
        Period period = 2;
        Duration duration = 3;
        Timing timing = 4;
      }
    }
    ParticipantEffectiveX participant_effective = 13;

    // Observation time from study start
    Duration participant_effective_time_from_start = 14;

    // mean | median | mean-of-mean | mean-of-median | median-of-mean |
    // median-of-median
    message ParticipantEffectiveGroupMeasureCode {
      option (.google.fhir.proto.structure_definition_kind) =
          KIND_PRIMITIVE_TYPE;
      option (.google.fhir.proto.fhir_valueset_url) =
          "http://hl7.org/fhir/ValueSet/group-measure";
      option (.google.fhir.proto.fhir_profile_base) =
          "http://hl7.org/fhir/StructureDefinition/code";

      GroupMeasureCode.Value value = 1;

      String id = 2;

      repeated Extension extension = 3;
    }
    ParticipantEffectiveGroupMeasureCode participant_effective_group_measure =
        15;
  }
  repeated Characteristic characteristic = 42
      [(.google.fhir.proto.validation_requirement) = REQUIRED_BY_FHIR];
}
