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

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

// Auto-generated from StructureDefinition for MedicinalProductPharmaceutical.
// A pharmaceutical product described in terms of its composition and dose form.
// See http://hl7.org/fhir/StructureDefinition/MedicinalProductPharmaceutical
message MedicinalProductPharmaceutical {
  option (.google.fhir.proto.structure_definition_kind) = KIND_RESOURCE;
  option (.google.fhir.proto.fhir_structure_definition_url) =
      "http://hl7.org/fhir/StructureDefinition/MedicinalProductPharmaceutical";

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

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

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

  // An identifier for the pharmaceutical medicinal product
  repeated Identifier identifier = 10;

  // The administrable dose form, after necessary reconstitution
  CodeableConcept administrable_dose_form = 11
      [(.google.fhir.proto.validation_requirement) = REQUIRED_BY_FHIR];

  // Todo
  CodeableConcept unit_of_presentation = 12;

  // Ingredient
  repeated Reference ingredient = 13
      [(.google.fhir.proto.valid_reference_type) =
           "MedicinalProductIngredient"];

  // Accompanying device
  repeated Reference device = 14
      [(.google.fhir.proto.valid_reference_type) = "DeviceDefinition"];

  // Characteristics e.g. a products onset of action
  message Characteristics {
    // 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;

    // A coded characteristic
    CodeableConcept code = 4
        [(.google.fhir.proto.validation_requirement) = REQUIRED_BY_FHIR];

    // The status of characteristic e.g. assigned or pending
    CodeableConcept status = 5;
  }
  repeated Characteristics characteristics = 15;

  // The path by which the pharmaceutical product is taken into or makes contact
  // with the body
  message RouteOfAdministration {
    // 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;

    // Coded expression for the route
    CodeableConcept code = 4
        [(.google.fhir.proto.validation_requirement) = REQUIRED_BY_FHIR];

    // The first dose (dose quantity) administered in humans can be specified,
    // for a product under investigation, using a numerical value and its unit
    // of measurement
    Quantity first_dose = 5;

    // The maximum single dose that can be administered as per the protocol of a
    // clinical trial can be specified using a numerical value and its unit of
    // measurement
    Quantity max_single_dose = 6;

    // The maximum dose per day (maximum dose quantity to be administered in any
    // one 24-h period) that can be administered as per the protocol referenced
    // in the clinical trial authorisation
    Quantity max_dose_per_day = 7;

    // The maximum dose per treatment period that can be administered as per the
    // protocol referenced in the clinical trial authorisation
    Ratio max_dose_per_treatment_period = 8;

    // The maximum treatment period during which an Investigational Medicinal
    // Product can be administered as per the protocol referenced in the
    // clinical trial authorisation
    Duration max_treatment_period = 9;

    // A species for which this route applies
    message TargetSpecies {
      // 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;

      // Coded expression for the species
      CodeableConcept code = 4
          [(.google.fhir.proto.validation_requirement) = REQUIRED_BY_FHIR];

      // A species specific time during which consumption of animal product is
      // not appropriate
      message WithdrawalPeriod {
        // 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;

        // Coded expression for the type of tissue for which the withdrawal
        // period applues, e.g. meat, milk
        CodeableConcept tissue = 4
            [(.google.fhir.proto.validation_requirement) = REQUIRED_BY_FHIR];

        // A value for the time
        Quantity value = 5
            [(.google.fhir.proto.validation_requirement) = REQUIRED_BY_FHIR];

        // Extra information about the withdrawal period
        String supporting_information = 6;
      }
      repeated WithdrawalPeriod withdrawal_period = 5;
    }
    repeated TargetSpecies target_species = 10;
  }
  repeated RouteOfAdministration route_of_administration = 16
      [(.google.fhir.proto.validation_requirement) = REQUIRED_BY_FHIR];
}
