Руководство к использованию стандарта FHIR в ЦИСЗ
0.1.1667 - ci-build

Руководство к использованию стандарта FHIR в ЦИСЗ - Local Development build (v0.1.1667) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Профиль ресурса: Опросник по анамнезу пациента

Официальный URL: https://fhir.by/StructureDefinition/QuestionnaireAnamnesisBy Version: 0.1.1667
Draft as of 2024-09-16 Имя: QuestionnaireAnamnesisBy

Профиль является общий для всех опросников по анамнезам.

Профиль QuestionnaireAnamnesisBy может быть использован в качестве базового для разработки опросников по различным видам анамнезов, таким как: анамнез жизни, трансфузиологический, акушерско-гинекологический, аллерголонический и др.

Usage:

Контент профиля

Описание профилей и принципов работы различных представлений..

Профиль ресурса: Questionnaire

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire 0..* Questionnaire Структурированный набор вопросов
... id 1..1 id Логический идентификатор этого артефакта
... meta 1..1 Meta Метаданные о ресурсе
.... extension 0..0
.... versionId 0..0
.... lastUpdated 0..0
.... source 0..0
.... profile 1..1 canonical(StructureDefinition) Профили, которым, как утверждается, соответствует этот ресурс
Required Pattern: https://fhir.by/StructureDefinition/QuestionnaireAnamnesisBy
.... security 0..0
.... tag 0..0
... implicitRules 0..0
... language 0..0
... contained 0..0
... extension 0..0
... modifierExtension 0..0
... url 0..1 uri Канонический идентификатор этой анкеты, представленный в виде абсолютного URI (глобально уникального).
... identifier 0..0
... version 0..0
... versionAlgorithm[x] 0..0
... name 1..1 string Название анкеты (для вычислений)
... title 1..1 string Название анкеты (понятное человеку)
... derivedFrom 0..0
... experimental 0..1 boolean Для целей тестирования, а не реального использования
... subjectType 1..1 code Ресурс, который может быть предметом QuestionnaireResponse
Required Pattern: Patient
... publisher 0..1 string Имя издателя (организация или физическое лицо)
... contact 0..0
... useContext 0..0
... jurisdiction 0..0
... purpose 0..0
... copyright 0..0
... copyrightLabel 0..0
... approvalDate 0..0
... lastReviewDate 0..0
... effectivePeriod 0..0
... code 0..0
... item 1..* BackboneElement Вопросы и разделы анкеты
.... id 0..0
.... extension 0..0
.... modifierExtension 0..0
.... linkId 1..1 string Уникальный идентификатор вопроса или раздела в анкете
.... code 0..0
.... prefix 0..0
.... text 1..1 string Основной текст для элемента
.... enableWhen 0..1 BackboneElement Разрешать передачу данных только в том случае, если
..... id 0..0
..... extension 0..0
..... modifierExtension 0..0
..... question 1..1 string LinkId вопроса, который определяет, включен/отключен ли элемент
..... answer[x] 1..1 boolean, decimal, integer, date, dateTime, time, string, Coding, Quantity, Reference(Resource) Сравнение значений вопросов на основе оператора
.... enableBehavior 0..0
.... required 0..1 boolean Должен ли элемент быть включен в результаты данных
.... repeats 0..1 boolean Может ли элемент повторяться
.... readOnly 0..0
.... maxLength 0..0
.... answerConstraint 0..0
.... answerValueSet 0..1 canonical(ValueSet) Набор значений, содержащий разрешенные ответы
.... answerOption 0..0
.... initial 0..1 BackboneElement Фактическое значение для инициализации вопроса
..... id 0..0
..... extension 0..0
..... modifierExtension 0..0
.... item 0..* Вложенные элементы анкеты

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire C 0..* Questionnaire Структурированный набор вопросов
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
que-2: The link ids for groups and questions must be unique within the questionnaire
... id Σ 1..1 id Логический идентификатор этого артефакта
... meta Σ 1..1 Meta Метаданные о ресурсе
.... id 0..1 id Уникальный идентификатор для межэлементных ссылок
.... extension 0..0
.... profile Σ 1..1 canonical(StructureDefinition) Профили, которым, как утверждается, соответствует этот ресурс

Required Pattern: https://fhir.by/StructureDefinition/QuestionnaireAnamnesisBy
... text 0..1 Narrative Краткое изложение текста ресурса для интерпретации человеком
... name ΣC 1..1 string Название анкеты (для вычислений)
... title Σ 1..1 string Название анкеты (понятное человеку)
... status ?!ΣC 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): Статус жизненного цикла артефакта.

... experimental Σ 0..1 boolean Для целей тестирования, а не реального использования
... subjectType Σ 1..1 code Ресурс, который может быть предметом QuestionnaireResponse
Binding: ResourceType (required): Один из типов ресурсов, определенных как часть этой версии FHIR.



Required Pattern: Patient
... date Σ 0..1 dateTime Дата последнего изменения
... publisher Σ 0..1 string Имя издателя (организация или физическое лицо)
... description Σ 0..1 markdown Описание анкеты
... item C 1..* BackboneElement Вопросы и разделы анкеты
que-1a: Group items must have nested items when Questionanire is complete
que-1b: Groups should have items
que-1c: Display items cannot have child items
que-3: Display items cannot have a "code" asserted
que-4: A question cannot have both answerOption and answerValueSet
que-5: Only coding, decimal, integer, date, dateTime, time, string or quantity items can have answerOption or answerValueSet
que-6: Required and repeat aren't permitted for display items
que-8: Initial values can't be specified for groups or display items
que-9: Read-only can't be specified for "display" items
que-10: Maximum length can only be declared for simple question types
que-11: If one or more answerOption is present, initial cannot be present. Use answerOption.initialSelected instead
que-12: If there are more than one enableWhen, enableBehavior must be specified
que-13: Can only have multiple initial values for repeating items
que-14: Can only have answerConstraint if answerOption or answerValueSet are present. (This is a warning because extensions may serve the same purpose)
.... linkId C 1..1 string Уникальный идентификатор вопроса или раздела в анкете
que-15: Link ids should be 255 characters or less
.... definition 0..1 uri Определение элемента - подробные сведения об элементе
.... text 1..1 string Основной текст для элемента
.... type C 1..1 code group | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required): Отличает группы от вопросов и отображает текст, а также указывает тип данных для вопросов.

.... enableWhen ?!C 0..1 BackboneElement Разрешать передачу данных только в том случае, если
que-7: If the operator is 'exists', the value must be a boolean
..... question 1..1 string LinkId вопроса, который определяет, включен/отключен ли элемент
..... operator C 1..1 code exists | = | != | > | < | >= | <=
Binding: QuestionnaireItemOperator (required): Критерии, по которым включается вопрос.

..... answer[x] C 1..1 Сравнение значений вопросов на основе оператора
Binding: QuestionnaireAnswerCodes (example): Допустимые значения для ответов на вопросы.

...... answerBoolean boolean
...... answerDecimal decimal
...... answerInteger integer
...... answerDate date
...... answerDateTime dateTime
...... answerTime time
...... answerString string
...... answerCoding Coding
...... answerQuantity Quantity
...... answerReference Reference(Resource)
.... disabledDisplay 0..1 code hidden | protected
Binding: QuestionnaireItemDisabledDisplay (required): Определяет, как должны отображаться отключенные элементы

.... required C 0..1 boolean Должен ли элемент быть включен в результаты данных
.... repeats C 0..1 boolean Может ли элемент повторяться
.... answerValueSet C 0..1 canonical(ValueSet) Набор значений, содержащий разрешенные ответы
.... initial C 0..1 BackboneElement Фактическое значение для инициализации вопроса
..... value[x] 1..1 Actual value for initializing the question
Binding: QuestionnaireAnswerCodes (example): Допустимые значения для ответов на вопросы.

...... valueBoolean boolean
...... valueDecimal decimal
...... valueInteger integer
...... valueDate date
...... valueDateTime dateTime
...... valueTime time
...... valueString string
...... valueUri uri
...... valueAttachment Attachment
...... valueCoding Coding
...... valueQuantity Quantity
...... valueReference Reference(Resource)
.... item 0..* See item (Questionnaire) Вложенные элементы анкеты

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Questionnaire.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
Questionnaire.subjectTyperequiredPattern: Patient
http://hl7.org/fhir/ValueSet/resource-types|5.0.0
from the FHIR Standard
Questionnaire.item.typerequiredQuestionnaireItemType
http://hl7.org/fhir/ValueSet/item-type|5.0.0
from the FHIR Standard
Questionnaire.item.enableWhen.operatorrequiredQuestionnaireItemOperator
http://hl7.org/fhir/ValueSet/questionnaire-enable-operator|5.0.0
from the FHIR Standard
Questionnaire.item.enableWhen.answer[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
http://hl7.org/fhir/ValueSet/questionnaire-answers
from the FHIR Standard
Questionnaire.item.disabledDisplayrequiredQuestionnaireItemDisabledDisplay
http://hl7.org/fhir/ValueSet/questionnaire-disabled-display|5.0.0
from the FHIR Standard
Questionnaire.item.answerOption.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
http://hl7.org/fhir/ValueSet/questionnaire-answers
from the FHIR Standard
Questionnaire.item.initial.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
http://hl7.org/fhir/ValueSet/questionnaire-answers
from the FHIR Standard

Профиль ресурса: Questionnaire

Summary

Mandatory: 8 elements
Prohibited: 41 elements

Схема различий

Профиль ресурса: Questionnaire

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire 0..* Questionnaire Структурированный набор вопросов
... id 1..1 id Логический идентификатор этого артефакта
... meta 1..1 Meta Метаданные о ресурсе
.... extension 0..0
.... versionId 0..0
.... lastUpdated 0..0
.... source 0..0
.... profile 1..1 canonical(StructureDefinition) Профили, которым, как утверждается, соответствует этот ресурс
Required Pattern: https://fhir.by/StructureDefinition/QuestionnaireAnamnesisBy
.... security 0..0
.... tag 0..0
... implicitRules 0..0
... language 0..0
... contained 0..0
... extension 0..0
... modifierExtension 0..0
... url 0..1 uri Канонический идентификатор этой анкеты, представленный в виде абсолютного URI (глобально уникального).
... identifier 0..0
... version 0..0
... versionAlgorithm[x] 0..0
... name 1..1 string Название анкеты (для вычислений)
... title 1..1 string Название анкеты (понятное человеку)
... derivedFrom 0..0
... experimental 0..1 boolean Для целей тестирования, а не реального использования
... subjectType 1..1 code Ресурс, который может быть предметом QuestionnaireResponse
Required Pattern: Patient
... publisher 0..1 string Имя издателя (организация или физическое лицо)
... contact 0..0
... useContext 0..0
... jurisdiction 0..0
... purpose 0..0
... copyright 0..0
... copyrightLabel 0..0
... approvalDate 0..0
... lastReviewDate 0..0
... effectivePeriod 0..0
... code 0..0
... item 1..* BackboneElement Вопросы и разделы анкеты
.... id 0..0
.... extension 0..0
.... modifierExtension 0..0
.... linkId 1..1 string Уникальный идентификатор вопроса или раздела в анкете
.... code 0..0
.... prefix 0..0
.... text 1..1 string Основной текст для элемента
.... enableWhen 0..1 BackboneElement Разрешать передачу данных только в том случае, если
..... id 0..0
..... extension 0..0
..... modifierExtension 0..0
..... question 1..1 string LinkId вопроса, который определяет, включен/отключен ли элемент
..... answer[x] 1..1 boolean, decimal, integer, date, dateTime, time, string, Coding, Quantity, Reference(Resource) Сравнение значений вопросов на основе оператора
.... enableBehavior 0..0
.... required 0..1 boolean Должен ли элемент быть включен в результаты данных
.... repeats 0..1 boolean Может ли элемент повторяться
.... readOnly 0..0
.... maxLength 0..0
.... answerConstraint 0..0
.... answerValueSet 0..1 canonical(ValueSet) Набор значений, содержащий разрешенные ответы
.... answerOption 0..0
.... initial 0..1 BackboneElement Фактическое значение для инициализации вопроса
..... id 0..0
..... extension 0..0
..... modifierExtension 0..0
.... item 0..* Вложенные элементы анкеты

doco Documentation for this format

Полная Схема

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire C 0..* Questionnaire Структурированный набор вопросов
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
que-2: The link ids for groups and questions must be unique within the questionnaire
... id Σ 1..1 id Логический идентификатор этого артефакта
... meta Σ 1..1 Meta Метаданные о ресурсе
.... id 0..1 id Уникальный идентификатор для межэлементных ссылок
.... extension 0..0
.... profile Σ 1..1 canonical(StructureDefinition) Профили, которым, как утверждается, соответствует этот ресурс

Required Pattern: https://fhir.by/StructureDefinition/QuestionnaireAnamnesisBy
... text 0..1 Narrative Краткое изложение текста ресурса для интерпретации человеком
... name ΣC 1..1 string Название анкеты (для вычислений)
... title Σ 1..1 string Название анкеты (понятное человеку)
... status ?!ΣC 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): Статус жизненного цикла артефакта.

... experimental Σ 0..1 boolean Для целей тестирования, а не реального использования
... subjectType Σ 1..1 code Ресурс, который может быть предметом QuestionnaireResponse
Binding: ResourceType (required): Один из типов ресурсов, определенных как часть этой версии FHIR.



Required Pattern: Patient
... date Σ 0..1 dateTime Дата последнего изменения
... publisher Σ 0..1 string Имя издателя (организация или физическое лицо)
... description Σ 0..1 markdown Описание анкеты
... item C 1..* BackboneElement Вопросы и разделы анкеты
que-1a: Group items must have nested items when Questionanire is complete
que-1b: Groups should have items
que-1c: Display items cannot have child items
que-3: Display items cannot have a "code" asserted
que-4: A question cannot have both answerOption and answerValueSet
que-5: Only coding, decimal, integer, date, dateTime, time, string or quantity items can have answerOption or answerValueSet
que-6: Required and repeat aren't permitted for display items
que-8: Initial values can't be specified for groups or display items
que-9: Read-only can't be specified for "display" items
que-10: Maximum length can only be declared for simple question types
que-11: If one or more answerOption is present, initial cannot be present. Use answerOption.initialSelected instead
que-12: If there are more than one enableWhen, enableBehavior must be specified
que-13: Can only have multiple initial values for repeating items
que-14: Can only have answerConstraint if answerOption or answerValueSet are present. (This is a warning because extensions may serve the same purpose)
.... linkId C 1..1 string Уникальный идентификатор вопроса или раздела в анкете
que-15: Link ids should be 255 characters or less
.... definition 0..1 uri Определение элемента - подробные сведения об элементе
.... text 1..1 string Основной текст для элемента
.... type C 1..1 code group | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required): Отличает группы от вопросов и отображает текст, а также указывает тип данных для вопросов.

.... enableWhen ?!C 0..1 BackboneElement Разрешать передачу данных только в том случае, если
que-7: If the operator is 'exists', the value must be a boolean
..... question 1..1 string LinkId вопроса, который определяет, включен/отключен ли элемент
..... operator C 1..1 code exists | = | != | > | < | >= | <=
Binding: QuestionnaireItemOperator (required): Критерии, по которым включается вопрос.

..... answer[x] C 1..1 Сравнение значений вопросов на основе оператора
Binding: QuestionnaireAnswerCodes (example): Допустимые значения для ответов на вопросы.

...... answerBoolean boolean
...... answerDecimal decimal
...... answerInteger integer
...... answerDate date
...... answerDateTime dateTime
...... answerTime time
...... answerString string
...... answerCoding Coding
...... answerQuantity Quantity
...... answerReference Reference(Resource)
.... disabledDisplay 0..1 code hidden | protected
Binding: QuestionnaireItemDisabledDisplay (required): Определяет, как должны отображаться отключенные элементы

.... required C 0..1 boolean Должен ли элемент быть включен в результаты данных
.... repeats C 0..1 boolean Может ли элемент повторяться
.... answerValueSet C 0..1 canonical(ValueSet) Набор значений, содержащий разрешенные ответы
.... initial C 0..1 BackboneElement Фактическое значение для инициализации вопроса
..... value[x] 1..1 Actual value for initializing the question
Binding: QuestionnaireAnswerCodes (example): Допустимые значения для ответов на вопросы.

...... valueBoolean boolean
...... valueDecimal decimal
...... valueInteger integer
...... valueDate date
...... valueDateTime dateTime
...... valueTime time
...... valueString string
...... valueUri uri
...... valueAttachment Attachment
...... valueCoding Coding
...... valueQuantity Quantity
...... valueReference Reference(Resource)
.... item 0..* See item (Questionnaire) Вложенные элементы анкеты

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Questionnaire.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
Questionnaire.subjectTyperequiredPattern: Patient
http://hl7.org/fhir/ValueSet/resource-types|5.0.0
from the FHIR Standard
Questionnaire.item.typerequiredQuestionnaireItemType
http://hl7.org/fhir/ValueSet/item-type|5.0.0
from the FHIR Standard
Questionnaire.item.enableWhen.operatorrequiredQuestionnaireItemOperator
http://hl7.org/fhir/ValueSet/questionnaire-enable-operator|5.0.0
from the FHIR Standard
Questionnaire.item.enableWhen.answer[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
http://hl7.org/fhir/ValueSet/questionnaire-answers
from the FHIR Standard
Questionnaire.item.disabledDisplayrequiredQuestionnaireItemDisabledDisplay
http://hl7.org/fhir/ValueSet/questionnaire-disabled-display|5.0.0
from the FHIR Standard
Questionnaire.item.answerOption.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
http://hl7.org/fhir/ValueSet/questionnaire-answers
from the FHIR Standard
Questionnaire.item.initial.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
http://hl7.org/fhir/ValueSet/questionnaire-answers
from the FHIR Standard

Профиль ресурса: Questionnaire

Summary

Mandatory: 8 elements
Prohibited: 41 elements

 


Примечания:

  • Создаваемые на базе профиля анкеты могут быть простыми (плоскими) списками вопросов или могут быть иерархически организованы в группы и подгруппы, каждая из которых содержит вопросы.
  • Автор (разработчик) анкеты определяет вопросы, которые следует задать, их порядок и группировку.
  • Заполненная анкета должна быть передана с помощью ресурса QuestionnaireResponse. 

Синтаксис метода получения ресурса

Метод получения осуществляет доступ к текущему содержимому ресурса. Взаимодействие осуществляется с помощью HTTP GET команды:

GET [base]/Questionnaire/[id]

Метод возвращает один экземпляр ресурса.

Возможные значения логического идентификатора («id») описаны в типе Id

При попытке доступа к несуществующему ресурсу будет возвращен HTTP статус код - 404 Not Found

Синтаксис поиска ресурса

Во всех поисковых взаимодействиях в этом руководстве используется HTTP GET команда со следующим синтаксисом:

GET [base]/[Resource-type]?[parameter1]{:m1|m2|...}={c1|c2|...}[value1{,value2,...}]{&[parameter2]{:m1|m2|...}={c1|c2|...}[value1{,value2,...}]&...}

  • GET — это HTTP метод, используемый для получения ресурса.

  • Переменные указанные в «[]», обязательны для предоставления клиентом и будут заменены указанным строковым литералом.

  • Переменные указанные в «{}», не являются обязательными для предоставления клиентом и будут заменены указанным строковым литералом.

  • base: URL-адрес сервера

  • Resource-type: имя типа ресурса (например, “Questionnaire”).

  • parameter: параметры поиска, определенные для конкретного взаимодействия (например, «?observation=Questionnaire/01»).

  • value: значение параметра поиска

  • : модификатор параметра поиска

  • {c1 c2 …}: компаратор параметра поиска

  • {,value2,…}: логическое ИЛИ

  • {&parameter2={:m1 m2 …}={c1 c2 …}[value1{,value2,…}]&…}: логическое И

Простой пример запроса поиска в RESTful с использованием HTTP GET команды:

GET [base]/Questionnaire?category=value&...

Параметр поиска Тип Описание Выражение Пример
​date date Дата публикации анкеты Questionnaire.date GET [base]/Questiionnaire?date=2024-05-01
​definition uri Определение элемента - подробные сведения об элементе Questionnaire.item.definition GET [base]/Questionnaire?url=https://www.rceth.by/Questionnaire/anamnesis_vitae/definition/7_108367-7_232518
​description string Описание анкеты Questionnaire.description GET [base]/Questionnaire?description=Содержит ряд вопросов по анамнезу жизни пациента
​name string Удобое для вычислений имя анкеты Questionnaire.name GET [base]/Questionnaire?name=AnanmesisVitaeAdultPatient
​publisher string Наименование издателя анкеты Questionnaire.publisher GET [base]/Questionnaire?publisher=fhir.by
​status token Текущее состояние опросника Questionnaire.status GET [base]/Questionnaire?status=active
​subject-type token Ресурс, который может быть предметом QuestionnaireResponse Questionnaire.subjectType GET [base]/Questionnaire?subjectType=Patient
​title string Понятное для человека название анкеты Questionnaire.title GET [base]/Questionnaire?title=Опросник по анамнезу пациента
​url uri URI, идентифицирующий анкету Questionnaire.url GET [base]/Questionnaire?url=https://fhir.by/StructureDefinition/QuestionnaireAnamnesisBy