Herriot:RegisterAnimalVeterinaryEvent:v1.0: различия между версиями

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
(Новая страница: «== Общие сведения == == Спецификация запроса == == Спецификация ответа == == Примеры запросов...»)
 
Строка 2: Строка 2:


== Спецификация запроса ==
== Спецификация запроса ==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<hrt:registerAnimalVeterinaryEventRequest>'''}}
|
|
| style="width:52em;"|
|-
|002
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:localTransactionId>'''}}{{color|#131313|?}}{{color|#190dbf|'''</hrt:localTransactionId>'''}}
|bs:Identifier
|[1..1]
| style="width:52em;"| Идентификатор заявки в клиентской системе
|-
|003
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:initiator>'''}}
|vd:User
|[1..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;">Пользователь, зарегистрированный в ВетИС, инициирующий запрос</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* является ответственным за выполнение бизнес-операции
* требуется логин ветврача или пользователя ХС, логин для базовой аутентификации не подойдёт</div>
</div>
|-
|004
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}login>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}login>'''}}
|xs:NCName
|[1..1]
| style="width:52em;"| Логин пользователя
|-
|005
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:initiator>'''}}
|
|
| style="width:52em;"|
|-
|006
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:referencedMedicationEvent>'''}}
|vd:AnimalMedicationEvent
|[1..*]
| style="width:52em;"| Проект сведений о ветеринарном профилактическом мероприятии
|-
|007
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}type>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}type>'''}}
|vd:VeterinaryEventType
|[1..1]
| style="width:52em;"| Тип мероприятия
|-
|008
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}actualDateTime>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}actualDateTime>'''}}
|xs:dateTime
|[1..1]
| style="width:52em;"| Дата мероприятия
|-
|009
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}operator>'''}}
|dt:Organization
|[0..1]
| style="width:52em;"| Сведения об операторе проводившем мероприятие
|-
|010
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}name>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}name>'''}}
|bs:String255
|[1..1]
| style="width:52em;"| Наименование оператора
|-
|011
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|vd:}}operator>'''}}
|
|
| style="width:52em;"|
|-
|012
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}authorizedPerson>'''}}
|vd:User
|[1..1]
| style="width:52em;"| Сведения о специалисте, проводившем мероприятие
|-
|013
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|vd:}}login>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}login>'''}}
|xs:NCName
|[0..1]
| style="width:52em;"| Логин уполномоченного лица
|-
|014
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|vd:}}fio>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}fio>'''}}
|bs:String255
|[0..1]
| style="width:52em;"| ФИО уполномоченного лица
|-
|015
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|vd:}}authorizedPerson>'''}}
|
|
| style="width:52em;"|
|-
|016
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}occurrenceReason>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}occurrenceReason>'''}}
|vd:AnimalLifecycleEventReason
|[1..1]
| style="width:52em;"| Основание проведения мероприятия
|-
|017
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}disease>'''}}
|dt:AnimalDisease
|[0..*]
| style="width:52em;"| Сведения о заболевании
|-
|018
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}}
|bs:UUID
|[1..1]
| style="width:52em;"| Глобальный идентификатор заболевания
|-
|019
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|vd:}}disease>'''}}
|
|
| style="width:52em;"|
|-
|020
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}medicinalDrug>'''}}
|dt:MedicinalDrug
|[0..1]
| style="width:52em;"| Сведения о препарате
|-
|021
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}}
|bs:UUID
|[1..1]
| style="width:52em;"| Глобальный идентификатор препарата
|-
|022
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}activeSubstance>'''}}
|dt:DrugActiveSubstance
|[0..*]
| style="width:52em;"| Действующее вещество препарата
|-
|023
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}}
|bs:UUID
|[1..1]
| style="width:52em;"| Глобальный идентификатор действующего вещества
|-
|024
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}activeSubstance>'''}}
|
|
| style="width:52em;"|
|-
|025
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|vd:}}medicinalDrug>'''}}
|
|
| style="width:52em;"|
|-
|026
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}vaccine>'''}}
|dt:Vaccine
|[1..1]
| style="width:52em;"| Сведения о вакцине
|-
|027
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}}
|bs:UUID
|[1..1]
| style="width:52em;"| Глобальный идентификатор вакцины
|-
|028
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|vd:}}vaccine>'''}}
|
|
| style="width:52em;"|
|-
|029
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}measuring>'''}}
|dt:Measure
|[1..1]
| style="width:52em;"| Дозировка препарата / вакцины
|-
|030
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}value>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}value>'''}}
|bs:Decimal
|[1..1]
| style="width:52em;"| Значение дозировки
|-
|031
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}unit>'''}}
|dt:Unit
|[1..1]
| style="width:52em;"| Единица измерения дозировки
|-
|032
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}}
|bs:UUID
|[1..1]
| style="width:52em;"| Глобальный идентификатор единицы измерения
|-
|033
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}unit>'''}}
|
|
| style="width:52em;"|
|-
|034
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|vd:}}measuring>'''}}
|
|
| style="width:52em;"|
|-
|035
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:referencedMedicationEvent>'''}}
|
|
| style="width:52em;"|
|-
|036
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:specifiedAnimalGroup>'''}}
|vd:ObservableAnimalGroup
|[1..*]
| style="width:52em;"| Сведения о животных (группе животных), в отношении которых осуществлялось мероприятие
|-
|037
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}specifiedAnimalGroup>'''}}
|dt:AnimalGroup
|[0..1]
| style="width:52em;"| Сведения о группе животных (в случае групповой идентификации)
|-
|038
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}size>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}size>'''}}
|xs:nonNegativeInteger
|[1..1]
| style="width:52em;"| Численность группы животных
|-
|039
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|vd:}}specifiedAnimalGroup>'''}}
|
|
| style="width:52em;"|
|-
|040
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}animalRegistrationRef>'''}}
|vd:AnimalRegistration
|[1..1]
| style="width:52em;"| Сведения о зарегистрированных животных (группах животных)
|-
|041
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}}
|bs:UUID
|[1..1]
| style="width:52em;"| Глобальный идентификатор учётной карточки
|-
|042
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|vd:}}animalRegistrationRef>'''}}
|
|
| style="width:52em;"|
|-
|043
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:specifiedAnimalGroup>'''}}
|
|
| style="width:52em;"|
|-
|044
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</hrt:registerAnimalVeterinaryEventRequest>'''}}
|
|
| style="width:52em;"|
|-
|}


== Спецификация ответа ==
== Спецификация ответа ==

Версия 08:54, 13 ноября 2023

Общие сведения

Спецификация запроса

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <hrt:registerAnimalVeterinaryEventRequest>
002 ···<hrt:localTransactionId>?</hrt:localTransactionId> bs:Identifier [1..1] Идентификатор заявки в клиентской системе
003 ···<hrt:initiator> vd:User [1..1]

Пользователь, зарегистрированный в ВетИС, инициирующий запрос

  • является ответственным за выполнение бизнес-операции
  • требуется логин ветврача или пользователя ХС, логин для базовой аутентификации не подойдёт
004 ······<vd:login>?</vd:login> xs:NCName [1..1] Логин пользователя
005 ···</hrt:initiator>
006 ···<hrt:referencedMedicationEvent> vd:AnimalMedicationEvent [1..*] Проект сведений о ветеринарном профилактическом мероприятии
007 ······<vd:type>?</vd:type> vd:VeterinaryEventType [1..1] Тип мероприятия
008 ······<vd:actualDateTime>?</vd:actualDateTime> xs:dateTime [1..1] Дата мероприятия
009 ······<vd:operator> dt:Organization [0..1] Сведения об операторе проводившем мероприятие
010 ·········<dt:name>?</dt:name> bs:String255 [1..1] Наименование оператора
011 ······</vd:operator>
012 ······<vd:authorizedPerson> vd:User [1..1] Сведения о специалисте, проводившем мероприятие
013 ·········<vd:login>?</vd:login> xs:NCName [0..1] Логин уполномоченного лица
014 ·········<vd:fio>?</vd:fio> bs:String255 [0..1] ФИО уполномоченного лица
015 ······</vd:authorizedPerson>
016 ······<vd:occurrenceReason>?</vd:occurrenceReason> vd:AnimalLifecycleEventReason [1..1] Основание проведения мероприятия
017 ······<vd:disease> dt:AnimalDisease [0..*] Сведения о заболевании
018 ·········<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор заболевания
019 ······</vd:disease>
020 ······<vd:medicinalDrug> dt:MedicinalDrug [0..1] Сведения о препарате
021 ·········<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор препарата
022 ·········<dt:activeSubstance> dt:DrugActiveSubstance [0..*] Действующее вещество препарата
023 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор действующего вещества
024 ·········</dt:activeSubstance>
025 ······</vd:medicinalDrug>
026 ······<vd:vaccine> dt:Vaccine [1..1] Сведения о вакцине
027 ·········<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор вакцины
028 ······</vd:vaccine>
029 ······<vd:measuring> dt:Measure [1..1] Дозировка препарата / вакцины
030 ·········<dt:value>?</dt:value> bs:Decimal [1..1] Значение дозировки
031 ·········<dt:unit> dt:Unit [1..1] Единица измерения дозировки
032 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор единицы измерения
033 ·········</dt:unit>
034 ······</vd:measuring>
035 ···</hrt:referencedMedicationEvent>
036 ···<hrt:specifiedAnimalGroup> vd:ObservableAnimalGroup [1..*] Сведения о животных (группе животных), в отношении которых осуществлялось мероприятие
037 ······<vd:specifiedAnimalGroup> dt:AnimalGroup [0..1] Сведения о группе животных (в случае групповой идентификации)
038 ·········<dt:size>?</dt:size> xs:nonNegativeInteger [1..1] Численность группы животных
039 ······</vd:specifiedAnimalGroup>
040 ······<vd:animalRegistrationRef> vd:AnimalRegistration [1..1] Сведения о зарегистрированных животных (группах животных)
041 ·········<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор учётной карточки
042 ······</vd:animalRegistrationRef>
043 ···</hrt:specifiedAnimalGroup>
044 </hrt:registerAnimalVeterinaryEventRequest>

Спецификация ответа

Примеры запросов

TODO

См. также

Вернуться к началу ↑
Вернуться на страницу профиля API Herriot:Services:v1.0

Источник — http://help.vetrf.ru/index.php?title=Herriot:RegisterAnimalVeterinaryEvent:v1.0&oldid=38321