Current Build

Переводит компания Health Samurai . Приглашаем поучаствовать в русификации стандарта FHIR: GitHub , Email.

14.4 Ресурс GuidanceResponse - Назначение

Clinical Decision Support Work GroupMaturity Level: 2 Trial UseCompartments: Not linked to any defined compartments

Ответ на запрос инструкции - это официальный ответ на запрос инструкции, включающий все выходные параметры, возвращаемые в результате вычисления, а также описание всех действий, которые необходимо предпринять.

Ресурс GuidanceResponse используется для представления результата вызова сервиса поддержки принятия решений. Он обеспечивает контейнер для статуса ответа, любых предупреждений или сообщений, возвращаемых сервисом, а также выходные данные модуля и любых предложенных к выполнению действий.

Более подробную информацию о процессе вычисления см. в теме Guidance Request в модуле Клиническое обоснование.

Note to implementers: The user-facing external clinical decision support use case supported by the ServiceDefinition/$evaluate operation of the Clinical Reasoning module has significant overlap with the functionality provided by the CDS Hooks specification. As part of FHIR Release 4, it is the intention to unify the CDS Hooks specification with the Clinical Reasoning module, ensuring that implementers have a single consistent mechanism to support this use case that meets the requirements of both the Clinical Quality Framework and CDS Hooks communities. Although the functionality in both specifications is conceptually aligned, this unification will likely result in changes to both specifications. The CQF and CDS Hooks project teams are committed to this unification and will work to ensure that the resulting changes have as little impact as possible on current and ongoing implementation efforts, while meeting the needs of both communities. The project team is planning on a workable implementation tested at the connectathon in May of 2017, with a trial ballot following in September 2017, targeting publication as part of the FHIR Release 4 specification.

Структура

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. GuidanceResponse DomainResourceОфициальный ответ на запрос инструкции
Элементы, определённые в прародителе: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... requestId Σ0..1idИдентификатор запроса, связанного с этим ответом, если есть
... identifier Σ0..1IdentifierBusiness identifier
... module Σ1..1Reference(ServiceDefinition)Ссылка на модуль знаний
... status ?!Σ1..1codesuccess | data-requested | data-required | in-progress | failure | entered-in-error
GuidanceResponseStatus (Required)
... subject 0..1Reference(Patient | Group)Patient the request was performed for
... context 0..1Reference(Encounter | EpisodeOfCare)Encounter or Episode during which the response was returned
... occurrenceDateTime 0..1dateTimeWhen the guidance response was processed
... performer 0..1Reference(Device)Device returning the guidance
... reason[x] 0..1Reason for the response
.... reasonCodeableConceptCodeableConcept
.... reasonReferenceReference(Any)
... note 0..*AnnotationAdditional notes about the response
... evaluationMessage 0..*Reference(OperationOutcome)Сообщения, возникающие при оценке артефакта или артефактов
... outputParameters 0..1Reference(Parameters)Выходные параметры оценки, если есть
... result 0..1Reference(CarePlan | RequestGroup)Действия, предложенные к выполнению, если есть
... dataRequirement 0..*DataRequirementДополнительные необходимые данные

doco Документация по этому формату

UML-диаграмма (Legend)

GuidanceResponse (DomainResource)Идентификатор запроса, связанный с этим ответом. Если идентификатор был указан в запросе, он будет приведён здесь для упрощения идентификации ответа запрашивающей стороной в сценариях с несколькими запросамиrequestId : id [0..1]Allows a service to provide a unique, business identifier for the responseidentifier : Identifier [0..1]Ссылка на модуль знаний, который был вызванmodule : Reference [1..1] « ServiceDefinition »Статус ответа. Если оценка будет успешно завершена, статус будет иметь значение "success". Однако для того, чтобы завершить оценку, системе может потребоваться более подробная информация. В этом случае статус будет "data-required", а ответ будет содержать описание необходимой дополнительной информации. Если оценка успешно завершена, но система определила, что потенциально может быть выдан более точный ответ, если будет доступно больше данных, то статус будут "data-requested", а ответ будет содержать описание дополнительно запрашиваемой информации (this element modifies the meaning of other elements)status : code [1..1] « Статус ответа на запрос инструкции (Strength=Required)GuidanceResponseStatus! »The patient for which the request was processedsubject : Reference [0..1] « Patient|Group »Allows the context of the guidance response to be provided if available. In a service context, this would likely be unavailablecontext : Reference [0..1] « Encounter|EpisodeOfCare »Indicates when the guidance response was processedoccurrenceDateTime : dateTime [0..1]Provides a reference to the device that performed the guidanceperformer : Reference [0..1] « Device »Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the responsereason[x] : Type [0..1] « CodeableConcept|Reference(Any) »Provides a mechanism to communicate additional information about the responsenote : Annotation [0..*]Сообщения, возникающие при оценке артефакта или артефактов. В рамках оценки запроса, система может выдавать информацию или предупреждающие сообщения. Эти сообщения передаются в этом элементеevaluationMessage : Reference [0..*] « OperationOutcome »Выходные параметры оценки, если таковые имеются. Многие модули возвращают конкретные ресурсы, такие как процедуры или запросы на коммуникацию, которые возвращаются в качестве части результата операции. Однако модули могут определять конкретные результаты, которые будут возвращены в результате оценки, и они будут переданы в этом элементеoutputParameters : Reference [0..1] « Parameters »Действия, если таковые имеются, полученные в результате оценки артефактаresult : Reference [0..1] « CarePlan|RequestGroup »Если вычисление не может быть выполнено из-за отсутствия информации либо дополнительная информация могла бы потенциально дать более точный ответ, то в этом элементе указывается описание данных, необходимых для выполнения этой оценки. Последующий запрос к этому сервису должен содержать эти данныеdataRequirement : DataRequirement [0..*]

XML-шаблон

<GuidanceResponse xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <requestId value="[id]"/><!-- 0..1 Идентификатор запроса, связанного с этим ответом, если есть -->
 <identifier><!-- 0..1 Identifier Business identifier --></identifier>
 <module><!-- 1..1 Reference(ServiceDefinition) Ссылка на модуль знаний --></module>
 <status value="[code]"/><!-- 1..1 success | data-requested | data-required | in-progress | failure | entered-in-error -->
 <subject><!-- 0..1 Reference(Patient|Group) Patient the request was performed for --></subject>
 <context><!-- 0..1 Reference(Encounter|EpisodeOfCare) Encounter or Episode during which the response was returned --></context>
 <occurrenceDateTime value="[dateTime]"/><!-- 0..1 When the guidance response was processed -->
 <performer><!-- 0..1 Reference(Device) Device returning the guidance --></performer>
 <reason[x]><!-- 0..1 CodeableConcept|Reference(Any) Reason for the response --></reason[x]>
 <note><!-- 0..* Annotation Additional notes about the response --></note>
 <evaluationMessage><!-- 0..* Reference(OperationOutcome) Сообщения, возникающие при оценке артефакта или артефактов --></evaluationMessage>
 <outputParameters><!-- 0..1 Reference(Parameters) Выходные параметры оценки, если есть --></outputParameters>
 <result><!-- 0..1 Reference(CarePlan|RequestGroup) Действия, предложенные к выполнению, если есть --></result>
 <dataRequirement><!-- 0..* DataRequirement Дополнительные необходимые данные --></dataRequirement>
</GuidanceResponse>

JSON-шаблон

{doco
  "resourceType" : "GuidanceResponse",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "requestId" : "<id>", // Идентификатор запроса, связанного с этим ответом, если есть
  "identifier" : { Identifier }, // Business identifier
  "module" : { Reference(ServiceDefinition) }, // R!  Ссылка на модуль знаний
  "status" : "<code>", // R!  success | data-requested | data-required | in-progress | failure | entered-in-error
  "subject" : { Reference(Patient|Group) }, // Patient the request was performed for
  "context" : { Reference(Encounter|EpisodeOfCare) }, // Encounter or Episode during which the response was returned
  "occurrenceDateTime" : "<dateTime>", // When the guidance response was processed
  "performer" : { Reference(Device) }, // Device returning the guidance
  // reason[x]: Reason for the response. One of these 2:
  "reasonCodeableConcept" : { CodeableConcept },
  "reasonReference" : { Reference(Any) },
  "note" : [{ Annotation }], // Additional notes about the response
  "evaluationMessage" : [{ Reference(OperationOutcome) }], // Сообщения, возникающие при оценке артефакта или артефактов
  "outputParameters" : { Reference(Parameters) }, // Выходные параметры оценки, если есть
  "result" : { Reference(CarePlan|RequestGroup) }, // Действия, предложенные к выполнению, если есть
  "dataRequirement" : [{ DataRequirement }] // Дополнительные необходимые данные
}

Turtle-шаблон

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:GuidanceResponse;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:GuidanceResponse.requestId [ id ]; # 0..1 Идентификатор запроса, связанного с этим ответом, если есть
  fhir:GuidanceResponse.identifier [ Identifier ]; # 0..1 Business identifier
  fhir:GuidanceResponse.module [ Reference(ServiceDefinition) ]; # 1..1 Ссылка на модуль знаний
  fhir:GuidanceResponse.status [ code ]; # 1..1 success | data-requested | data-required | in-progress | failure | entered-in-error
  fhir:GuidanceResponse.subject [ Reference(Patient|Group) ]; # 0..1 Patient the request was performed for
  fhir:GuidanceResponse.context [ Reference(Encounter|EpisodeOfCare) ]; # 0..1 Encounter or Episode during which the response was returned
  fhir:GuidanceResponse.occurrenceDateTime [ dateTime ]; # 0..1 When the guidance response was processed
  fhir:GuidanceResponse.performer [ Reference(Device) ]; # 0..1 Device returning the guidance
  # GuidanceResponse.reason[x] : 0..1 Reason for the response. One of these 2
    fhir:GuidanceResponse.reasonCodeableConcept [ CodeableConcept ]
    fhir:GuidanceResponse.reasonReference [ Reference(Any) ]
  fhir:GuidanceResponse.note [ Annotation ], ... ; # 0..* Additional notes about the response
  fhir:GuidanceResponse.evaluationMessage [ Reference(OperationOutcome) ], ... ; # 0..* Сообщения, возникающие при оценке артефакта или артефактов
  fhir:GuidanceResponse.outputParameters [ Reference(Parameters) ]; # 0..1 Выходные параметры оценки, если есть
  fhir:GuidanceResponse.result [ Reference(CarePlan|RequestGroup) ]; # 0..1 Действия, предложенные к выполнению, если есть
  fhir:GuidanceResponse.dataRequirement [ DataRequirement ], ... ; # 0..* Дополнительные необходимые данные
]

Changes since DSTU2

This resource did not exist in Release 2

This analysis is available as XML or JSON.

Структура

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. GuidanceResponse DomainResourceОфициальный ответ на запрос инструкции
Элементы, определённые в прародителе: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... requestId Σ0..1idИдентификатор запроса, связанного с этим ответом, если есть
... identifier Σ0..1IdentifierBusiness identifier
... module Σ1..1Reference(ServiceDefinition)Ссылка на модуль знаний
... status ?!Σ1..1codesuccess | data-requested | data-required | in-progress | failure | entered-in-error
GuidanceResponseStatus (Required)
... subject 0..1Reference(Patient | Group)Patient the request was performed for
... context 0..1Reference(Encounter | EpisodeOfCare)Encounter or Episode during which the response was returned
... occurrenceDateTime 0..1dateTimeWhen the guidance response was processed
... performer 0..1Reference(Device)Device returning the guidance
... reason[x] 0..1Reason for the response
.... reasonCodeableConceptCodeableConcept
.... reasonReferenceReference(Any)
... note 0..*AnnotationAdditional notes about the response
... evaluationMessage 0..*Reference(OperationOutcome)Сообщения, возникающие при оценке артефакта или артефактов
... outputParameters 0..1Reference(Parameters)Выходные параметры оценки, если есть
... result 0..1Reference(CarePlan | RequestGroup)Действия, предложенные к выполнению, если есть
... dataRequirement 0..*DataRequirementДополнительные необходимые данные

doco Документация по этому формату

UML-диаграмма (Legend)

GuidanceResponse (DomainResource)Идентификатор запроса, связанный с этим ответом. Если идентификатор был указан в запросе, он будет приведён здесь для упрощения идентификации ответа запрашивающей стороной в сценариях с несколькими запросамиrequestId : id [0..1]Allows a service to provide a unique, business identifier for the responseidentifier : Identifier [0..1]Ссылка на модуль знаний, который был вызванmodule : Reference [1..1] « ServiceDefinition »Статус ответа. Если оценка будет успешно завершена, статус будет иметь значение "success". Однако для того, чтобы завершить оценку, системе может потребоваться более подробная информация. В этом случае статус будет "data-required", а ответ будет содержать описание необходимой дополнительной информации. Если оценка успешно завершена, но система определила, что потенциально может быть выдан более точный ответ, если будет доступно больше данных, то статус будут "data-requested", а ответ будет содержать описание дополнительно запрашиваемой информации (this element modifies the meaning of other elements)status : code [1..1] « Статус ответа на запрос инструкции (Strength=Required)GuidanceResponseStatus! »The patient for which the request was processedsubject : Reference [0..1] « Patient|Group »Allows the context of the guidance response to be provided if available. In a service context, this would likely be unavailablecontext : Reference [0..1] « Encounter|EpisodeOfCare »Indicates when the guidance response was processedoccurrenceDateTime : dateTime [0..1]Provides a reference to the device that performed the guidanceperformer : Reference [0..1] « Device »Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the responsereason[x] : Type [0..1] « CodeableConcept|Reference(Any) »Provides a mechanism to communicate additional information about the responsenote : Annotation [0..*]Сообщения, возникающие при оценке артефакта или артефактов. В рамках оценки запроса, система может выдавать информацию или предупреждающие сообщения. Эти сообщения передаются в этом элементеevaluationMessage : Reference [0..*] « OperationOutcome »Выходные параметры оценки, если таковые имеются. Многие модули возвращают конкретные ресурсы, такие как процедуры или запросы на коммуникацию, которые возвращаются в качестве части результата операции. Однако модули могут определять конкретные результаты, которые будут возвращены в результате оценки, и они будут переданы в этом элементеoutputParameters : Reference [0..1] « Parameters »Действия, если таковые имеются, полученные в результате оценки артефактаresult : Reference [0..1] « CarePlan|RequestGroup »Если вычисление не может быть выполнено из-за отсутствия информации либо дополнительная информация могла бы потенциально дать более точный ответ, то в этом элементе указывается описание данных, необходимых для выполнения этой оценки. Последующий запрос к этому сервису должен содержать эти данныеdataRequirement : DataRequirement [0..*]

XML-шаблон

<GuidanceResponse xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <requestId value="[id]"/><!-- 0..1 Идентификатор запроса, связанного с этим ответом, если есть -->
 <identifier><!-- 0..1 Identifier Business identifier --></identifier>
 <module><!-- 1..1 Reference(ServiceDefinition) Ссылка на модуль знаний --></module>
 <status value="[code]"/><!-- 1..1 success | data-requested | data-required | in-progress | failure | entered-in-error -->
 <subject><!-- 0..1 Reference(Patient|Group) Patient the request was performed for --></subject>
 <context><!-- 0..1 Reference(Encounter|EpisodeOfCare) Encounter or Episode during which the response was returned --></context>
 <occurrenceDateTime value="[dateTime]"/><!-- 0..1 When the guidance response was processed -->
 <performer><!-- 0..1 Reference(Device) Device returning the guidance --></performer>
 <reason[x]><!-- 0..1 CodeableConcept|Reference(Any) Reason for the response --></reason[x]>
 <note><!-- 0..* Annotation Additional notes about the response --></note>
 <evaluationMessage><!-- 0..* Reference(OperationOutcome) Сообщения, возникающие при оценке артефакта или артефактов --></evaluationMessage>
 <outputParameters><!-- 0..1 Reference(Parameters) Выходные параметры оценки, если есть --></outputParameters>
 <result><!-- 0..1 Reference(CarePlan|RequestGroup) Действия, предложенные к выполнению, если есть --></result>
 <dataRequirement><!-- 0..* DataRequirement Дополнительные необходимые данные --></dataRequirement>
</GuidanceResponse>

JSON-шаблон

{doco
  "resourceType" : "GuidanceResponse",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "requestId" : "<id>", // Идентификатор запроса, связанного с этим ответом, если есть
  "identifier" : { Identifier }, // Business identifier
  "module" : { Reference(ServiceDefinition) }, // R!  Ссылка на модуль знаний
  "status" : "<code>", // R!  success | data-requested | data-required | in-progress | failure | entered-in-error
  "subject" : { Reference(Patient|Group) }, // Patient the request was performed for
  "context" : { Reference(Encounter|EpisodeOfCare) }, // Encounter or Episode during which the response was returned
  "occurrenceDateTime" : "<dateTime>", // When the guidance response was processed
  "performer" : { Reference(Device) }, // Device returning the guidance
  // reason[x]: Reason for the response. One of these 2:
  "reasonCodeableConcept" : { CodeableConcept },
  "reasonReference" : { Reference(Any) },
  "note" : [{ Annotation }], // Additional notes about the response
  "evaluationMessage" : [{ Reference(OperationOutcome) }], // Сообщения, возникающие при оценке артефакта или артефактов
  "outputParameters" : { Reference(Parameters) }, // Выходные параметры оценки, если есть
  "result" : { Reference(CarePlan|RequestGroup) }, // Действия, предложенные к выполнению, если есть
  "dataRequirement" : [{ DataRequirement }] // Дополнительные необходимые данные
}

Turtle-шаблон

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:GuidanceResponse;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:GuidanceResponse.requestId [ id ]; # 0..1 Идентификатор запроса, связанного с этим ответом, если есть
  fhir:GuidanceResponse.identifier [ Identifier ]; # 0..1 Business identifier
  fhir:GuidanceResponse.module [ Reference(ServiceDefinition) ]; # 1..1 Ссылка на модуль знаний
  fhir:GuidanceResponse.status [ code ]; # 1..1 success | data-requested | data-required | in-progress | failure | entered-in-error
  fhir:GuidanceResponse.subject [ Reference(Patient|Group) ]; # 0..1 Patient the request was performed for
  fhir:GuidanceResponse.context [ Reference(Encounter|EpisodeOfCare) ]; # 0..1 Encounter or Episode during which the response was returned
  fhir:GuidanceResponse.occurrenceDateTime [ dateTime ]; # 0..1 When the guidance response was processed
  fhir:GuidanceResponse.performer [ Reference(Device) ]; # 0..1 Device returning the guidance
  # GuidanceResponse.reason[x] : 0..1 Reason for the response. One of these 2
    fhir:GuidanceResponse.reasonCodeableConcept [ CodeableConcept ]
    fhir:GuidanceResponse.reasonReference [ Reference(Any) ]
  fhir:GuidanceResponse.note [ Annotation ], ... ; # 0..* Additional notes about the response
  fhir:GuidanceResponse.evaluationMessage [ Reference(OperationOutcome) ], ... ; # 0..* Сообщения, возникающие при оценке артефакта или артефактов
  fhir:GuidanceResponse.outputParameters [ Reference(Parameters) ]; # 0..1 Выходные параметры оценки, если есть
  fhir:GuidanceResponse.result [ Reference(CarePlan|RequestGroup) ]; # 0..1 Действия, предложенные к выполнению, если есть
  fhir:GuidanceResponse.dataRequirement [ DataRequirement ], ... ; # 0..* Дополнительные необходимые данные
]

Changes since DSTU2

This resource did not exist in Release 2

This analysis is available as XML or JSON.

 

Альтернативные определения: Основное определение (XML, JSON), XML Schema/Schematron + JSON Schema, ShEx (for Turtle)

ПутьОписаниеТипСсылка
GuidanceResponse.status Статус ответа на запрос инструкцииRequiredGuidanceResponseStatus

Although the GuidanceResponse resource does define search parameters, it is up to the individual decision support service whether or not historical records of guidance requests are preserved. A service may not support searching on GuidanceResponses at all, or it may support searching only for a pre-defined expiration period. The search parameters are defined to provide consumers with a consistent interface to searching if it is available for a specific service implementation. In any case, services should detail the support they do provide using a CapabilityStatement.

Параметры поиска для этого ресурса. Также к нему применяются общие параметры. Более подробную информацию о поиске в REST, обмене сообщениями и сервисах см. в разделе Поиск.

ИмяТипОписаниеВыражениеIn Common
identifiertokenThe identifier of the guidance responseGuidanceResponse.identifier
patientreferenceThe identity of a patient to search for guidance response resultsGuidanceResponse.subject
(Patient)
requesttokenThe identifier of the request associated with the responseGuidanceResponse.requestId
subjectreferenceThe subject that the guidance response is aboutGuidanceResponse.subject
(Group, Patient)