Current Build

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

14.12 JSON Schema for GuidanceResponse

Clinical Decision Support Work GroupMaturity Level: N/ABallot Status: Informative Compartments: Not linked to any defined compartments

This is a representation of the json schema for GuidanceResponse, which is just a part of the full JSON Schema.

{
  "$schema": "http://json-schema.org/draft-06/schema#",
  "id": "http://hl7.org/fhir/json-schema/GuidanceResponse",
  "$ref": "#/definitions/GuidanceResponse",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "GuidanceResponse": {
      "description": "Ответ на запрос инструкции - это официальный ответ на запрос инструкции, включающий все выходные параметры, возвращаемые в результате вычисления, а также описание всех действий, которые необходимо предпринять.",
      "properties": {
        "resourceType": {
          "description": "This is a GuidanceResponse resource",
          "const": "GuidanceResponse"
        },
        "id": {
          "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
          "$ref": "id.schema.json#/definitions/id"
        },
        "meta": {
          "description": "Метаданные ресурса. Это такая информация, которая поддерживается инфраструктурой. Изменения этой информации не всегда можно ассоциировать с версионными изменениями ресурса.",
          "$ref": "Meta.schema.json#/definitions/Meta"
        },
        "implicitRules": {
          "description": "Ссылка на свод правил, которым следовали при создании этого ресурса и которые необходимо понимать при обработке этого содержимого. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
          "$ref": "#/definitions/uri"
        },
        "_implicitRules": {
          "description": "Extensions for implicitRules",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "language": {
          "description": "Основной язык, на котором написан ресурс.",
          "$ref": "#/definitions/code"
        },
        "_language": {
          "description": "Extensions for language",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "text": {
          "description": "Человекочитаемая описательная часть, содержащая краткое изложение ресурса, которая может использоваться для представления содержимого ресурса человеку. От описательной части не требуется кодировать все структурированные данные, но она должна содержать достаточно сведений, чтобы простое её прочтение человеком было \"клинически безопасным\". Определения ресурсов могут описывать, какое содержимое должно быть представлено в описательной части для обеспечения клинической безопасной.",
          "$ref": "Narrative.schema.json#/definitions/Narrative"
        },
        "contained": {
          "description": "Эти ресурсы не обладают независимым существованием вне ресурса, который их содержит - их нельзя идентифицировать независимо, и они не могут иметь своей собственной независимой транзакционной области действия.",
          "items": {
            "$ref": "ResourceList.schema.json#/definitions/ResourceList"
          },
          "type": "array"
        },
        "extension": {
          "description": "Может использоваться для представления дополнительной информации, не являющейся частью базового определения ресурса. Чтобы сделать использование расширений надежным и управляемым, существует строгий набор управления применительно к определению и использованию расширений. Хотя каждому реализатору разрешается определять расширения, имеется набор требований, которые должны выполняться в рамках определения расширения.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "requestIdentifier": {
          "description": "The identifier of the request associated with this response. If an identifier was given as part of the request, it will be reproduced here to enable the requester to more easily identify the response in a multi-request scenario.",
          "$ref": "Identifier.schema.json#/definitions/Identifier"
        },
        "identifier": {
          "description": "Allows a service to provide  unique, business identifiers for the response.",
          "items": {
            "$ref": "Identifier.schema.json#/definitions/Identifier"
          },
          "type": "array"
        },
        "moduleUri": {
          "description": "An identifier, CodeableConcept or canonical reference to the guidance that was requested.",
          "pattern": "^\\S*$",
          "type": "string"
        },
        "_moduleUri": {
          "description": "Extensions for moduleUri",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "moduleCanonical": {
          "description": "An identifier, CodeableConcept or canonical reference to the guidance that was requested.",
          "pattern": "^\\S*$",
          "type": "string"
        },
        "_moduleCanonical": {
          "description": "Extensions for moduleCanonical",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "moduleCodeableConcept": {
          "description": "An identifier, CodeableConcept or canonical reference to the guidance that was requested.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "status": {
          "description": "Статус ответа. Если оценка будет успешно завершена, статус будет иметь значение \"success\". Однако для того, чтобы завершить оценку, системе может потребоваться более подробная информация. В этом случае статус будет \"data-required\", а ответ будет содержать описание необходимой дополнительной информации. Если оценка успешно завершена, но система определила, что потенциально может быть выдан более точный ответ, если будет доступно больше данных, то статус будут \"data-requested\", а ответ будет содержать описание дополнительно запрашиваемой информации.",
          "enum": [
            "success",
            "data-requested",
            "data-required",
            "in-progress",
            "failure",
            "entered-in-error"
          ]
        },
        "_status": {
          "description": "Extensions for status",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "subject": {
          "description": "The patient for which the request was processed.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "encounter": {
          "description": "The encounter during which this response was created or to which the creation of this record is tightly associated.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "occurrenceDateTime": {
          "description": "Indicates when the guidance response was processed.",
          "$ref": "#/definitions/dateTime"
        },
        "_occurrenceDateTime": {
          "description": "Extensions for occurrenceDateTime",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "performer": {
          "description": "Provides a reference to the device that performed the guidance.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "reasonCode": {
          "description": "Describes the reason for the guidance response in coded or textual form.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "reasonReference": {
          "description": "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 response.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "note": {
          "description": "Provides a mechanism to communicate additional information about the response.",
          "items": {
            "$ref": "Annotation.schema.json#/definitions/Annotation"
          },
          "type": "array"
        },
        "evaluationMessage": {
          "description": "Сообщения, возникающие при оценке артефакта или артефактов. В рамках оценки запроса, система может выдавать информацию или предупреждающие сообщения. Эти сообщения передаются в этом элементе.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "outputParameters": {
          "description": "Выходные параметры оценки, если таковые имеются. Многие модули возвращают конкретные ресурсы, такие как процедуры или запросы на коммуникацию, которые возвращаются в качестве части результата операции. Однако модули могут определять конкретные результаты, которые будут возвращены в результате оценки, и они будут переданы в этом элементе.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "result": {
          "description": "Действия, если таковые имеются, полученные в результате оценки артефакта.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "dataRequirement": {
          "description": "Если вычисление не может быть выполнено из-за отсутствия информации либо дополнительная информация могла бы потенциально дать более точный ответ, то в этом элементе указывается описание данных, необходимых для выполнения этой оценки. Последующий запрос к этому сервису должен содержать эти данные.",
          "items": {
            "$ref": "DataRequirement.schema.json#/definitions/DataRequirement"
          },
          "type": "array"
        }
      },
      "additionalProperties": false,
      "required": [
        "resourceType"
      ]
    }
  }
}