POST api/pharmacogen

Проверка группы препаратов на наличие побочных действий.

Описание запроса (Request).

Параметры тела запроса (Body Parameters)

Секция medication является обязательной для заполнения и передачи в запросе. Параметры terms, mkbIds, sideEffectsFreq - опциональные: в случае указания terms или mkbIds искомая информация о побочных действиях будет определяться во множестве терминов из массива terms, объединённого с терминами, имеющими отношение к нозологиям из списка mkbIds; указав sideEffectsFreq, можно отфильтровать данные по частоте проявления.

CheckPharmacogeneticsRequest
Название параметраОписаниеТипПримечание
visitId

Идентификатор визита

integer
checkUpType

Вариант проверки

integer
medication

Список лекарственных препаратов

Collection of PrepInfo
patient

Информация о пациенте - опционально

PatientInfo

Форматы запроса (Request Formats)

application/json, text/json

Sample:
{
  "medication": [
    {
      "activeSubstanceId": 1,
      "dosageFormId": 1
    },
    {
      "activeSubstanceId": 1,
      "dosageFormId": 1
    }
  ],
  "patient": {
    "parameters": [
      {
        "paramId": 1,
        "selectorId": 1,
        "value": "sample string 2",
        "unitId": 1
      },
      {
        "paramId": 1,
        "selectorId": 1,
        "value": "sample string 2",
        "unitId": 1
      }
    ],
    "genes": [
      {
        "gene": {
          "id": 1,
          "name": "sample string 1"
        },
        "alleles": {
          "allele1": {
            "id": 1,
            "name": "sample string 1"
          },
          "allele2": {
            "id": 1,
            "name": "sample string 1"
          }
        },
        "gene_variant": {
          "id": 1,
          "name": "sample string 1"
        }
      },
      {
        "gene": {
          "id": 1,
          "name": "sample string 1"
        },
        "alleles": {
          "allele1": {
            "id": 1,
            "name": "sample string 1"
          },
          "allele2": {
            "id": 1,
            "name": "sample string 1"
          }
        },
        "gene_variant": {
          "id": 1,
          "name": "sample string 1"
        }
      }
    ]
  },
  "visitId": 1,
  "checkUpType": 1
}

application/xml, text/xml

Sample:
<CheckPharmacogeneticsRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <preps>
    <PrepInfo>
      <activeSubstanceId>1</activeSubstanceId>
      <dosageFormId>1</dosageFormId>
    </PrepInfo>
    <PrepInfo>
      <activeSubstanceId>1</activeSubstanceId>
      <dosageFormId>1</dosageFormId>
    </PrepInfo>
  </preps>
  <patientInfo>
    <vitalparams>
      <VitalParameterInfo>
        <paramId>1</paramId>
        <selectorId>1</selectorId>
        <value>sample string 2</value>
        <unitId>1</unitId>
      </VitalParameterInfo>
      <VitalParameterInfo>
        <paramId>1</paramId>
        <selectorId>1</selectorId>
        <value>sample string 2</value>
        <unitId>1</unitId>
      </VitalParameterInfo>
    </vitalparams>
    <genes>
      <GeneRequestInfo>
        <gene>
          <gene_id>1</gene_id>
          <gene_name>sample string 1</gene_name>
        </gene>
        <alleles>
          <allele1>
            <allele_id>1</allele_id>
            <allele_name>sample string 1</allele_name>
          </allele1>
          <allele2>
            <allele_id>1</allele_id>
            <allele_name>sample string 1</allele_name>
          </allele2>
        </alleles>
        <gen_var>
          <gene_var_id>1</gene_var_id>
          <gene_var>sample string 1</gene_var>
        </gen_var>
      </GeneRequestInfo>
      <GeneRequestInfo>
        <gene>
          <gene_id>1</gene_id>
          <gene_name>sample string 1</gene_name>
        </gene>
        <alleles>
          <allele1>
            <allele_id>1</allele_id>
            <allele_name>sample string 1</allele_name>
          </allele1>
          <allele2>
            <allele_id>1</allele_id>
            <allele_name>sample string 1</allele_name>
          </allele2>
        </alleles>
        <gen_var>
          <gene_var_id>1</gene_var_id>
          <gene_var>sample string 1</gene_var>
        </gen_var>
      </GeneRequestInfo>
    </genes>
  </patientInfo>
  <visit_id>1</visit_id>
  <check_up_type>1</check_up_type>
</CheckPharmacogeneticsRequest>

Описание ответа (Response)

Collection of au_check_pharmacogenetics_Result
Название параметраОписаниеТипПримечание
as_id

integer
as_name

string

Длина строки: 768

gene_id

integer
gene

string

Длина строки: 50

allele1_id

integer
allele1

string

Длина строки: 50

allele2_id

integer
allele2

string

Длина строки: 50

gene_variant_id

integer
gene_variant

string

Длина строки: 50

phenotype_category_id

integer
phenotype_category

string

Длина строки: 32

implications

string

Длина строки: 2048

recommendations

string

Длина строки: 2048

likely_phenotype

string

Длина строки: 2048

patient_group_id

integer
patient_group

string

Длина строки: 50

Форматы ответа (Response Formats)

application/json, text/json

Sample:
[
  {
    "as_id": 1,
    "as_name": "sample string 1",
    "gene_id": 2,
    "gene": "sample string 3",
    "allele1_id": 1,
    "allele1": "sample string 4",
    "allele2_id": 1,
    "allele2": "sample string 5",
    "gene_variant_id": 1,
    "gene_variant": "sample string 6",
    "phenotype_category_id": 1,
    "phenotype_category": "sample string 7",
    "implications": "sample string 8",
    "recommendations": "sample string 9",
    "likely_phenotype": "sample string 10",
    "patient_group_id": 1,
    "patient_group": "sample string 11"
  },
  {
    "as_id": 1,
    "as_name": "sample string 1",
    "gene_id": 2,
    "gene": "sample string 3",
    "allele1_id": 1,
    "allele1": "sample string 4",
    "allele2_id": 1,
    "allele2": "sample string 5",
    "gene_variant_id": 1,
    "gene_variant": "sample string 6",
    "phenotype_category_id": 1,
    "phenotype_category": "sample string 7",
    "implications": "sample string 8",
    "recommendations": "sample string 9",
    "likely_phenotype": "sample string 10",
    "patient_group_id": 1,
    "patient_group": "sample string 11"
  }
]

application/xml, text/xml

Sample:
<ArrayOfAu_check_pharmacogenetics_Result xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <au_check_pharmacogenetics_Result>
    <as_id>1</as_id>
    <as_name>sample string 1</as_name>
    <gene_id>2</gene_id>
    <gene>sample string 3</gene>
    <allele1_id>1</allele1_id>
    <allele1>sample string 4</allele1>
    <allele2_id>1</allele2_id>
    <allele2>sample string 5</allele2>
    <gene_variant_id>1</gene_variant_id>
    <gene_variant>sample string 6</gene_variant>
    <phenotype_category_id>1</phenotype_category_id>
    <phenotype_category>sample string 7</phenotype_category>
    <implications>sample string 8</implications>
    <recommendations>sample string 9</recommendations>
    <likely_phenotype>sample string 10</likely_phenotype>
    <patient_group_id>1</patient_group_id>
    <patient_group>sample string 11</patient_group>
  </au_check_pharmacogenetics_Result>
  <au_check_pharmacogenetics_Result>
    <as_id>1</as_id>
    <as_name>sample string 1</as_name>
    <gene_id>2</gene_id>
    <gene>sample string 3</gene>
    <allele1_id>1</allele1_id>
    <allele1>sample string 4</allele1>
    <allele2_id>1</allele2_id>
    <allele2>sample string 5</allele2>
    <gene_variant_id>1</gene_variant_id>
    <gene_variant>sample string 6</gene_variant>
    <phenotype_category_id>1</phenotype_category_id>
    <phenotype_category>sample string 7</phenotype_category>
    <implications>sample string 8</implications>
    <recommendations>sample string 9</recommendations>
    <likely_phenotype>sample string 10</likely_phenotype>
    <patient_group_id>1</patient_group_id>
    <patient_group>sample string 11</patient_group>
  </au_check_pharmacogenetics_Result>
</ArrayOfAu_check_pharmacogenetics_Result>