Current Build

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

2.48 JSON Schema for MessageHeader

Infrastructure And Messaging Work GroupMaturity Level: N/ABallot Status: Informative Compartments: Device, Practitioner

This is a representation of the json schema for MessageHeader, 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/MessageHeader",
  "$ref": "#/definitions/MessageHeader",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "MessageHeader": {
      "description": "Заголовок сообщения обмена, которое либо запрашивает, либо отвечает на действие. Reference(s), являющиеся субъектами этого действия, также как и другая информация, связанная с этим действием, обычно передаются в виде комплекта, в котором первым идёт экземпляр ресурса MessageHeader.",
      "properties": {
        "resourceType": {
          "description": "This is a MessageHeader resource",
          "const": "MessageHeader"
        },
        "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"
        },
        "eventCoding": {
          "description": "Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value \"http://terminology.hl7.org/CodeSystem/message-events\".  Alternatively uri to the EventDefinition.",
          "$ref": "Coding.schema.json#/definitions/Coding"
        },
        "eventUri": {
          "description": "Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value \"http://terminology.hl7.org/CodeSystem/message-events\".  Alternatively uri to the EventDefinition.",
          "pattern": "^\\S*$",
          "type": "string"
        },
        "_eventUri": {
          "description": "Extensions for eventUri",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "destination": {
          "description": "Целевое приложение, которому предназначено это сообщение.",
          "items": {
            "$ref": "#/definitions/MessageHeader_Destination"
          },
          "type": "array"
        },
        "sender": {
          "description": "Identifies the sending system to allow the use of a trust relationship.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "enterer": {
          "description": "Физическое лицо или устройство, выполнившее ввод данных, вызвавшее это сообщение. Когда имеется несколько кандидатур, выберите наиболее подходящую к сообщению. Остальных можно будет указать в расширениях.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "author": {
          "description": "Логический автор сообщения - физическое лицо или устройство, принявшее решение о том, что описанное событие должно произойти. Когда имеется несколько кандидатур, выберите наиболее подходящую к MessageHeader. Остальных авторов можно будет указать в расширениях.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "source": {
          "description": "Исходное приложение, откуда пришло сообщение.",
          "$ref": "#/definitions/MessageHeader_Source"
        },
        "responsible": {
          "description": "Физическое лицо или организация, которые принимают полную ответственность за содержимое этого сообщения. Подразумевается, что событие в сообщении произошло в рамках политики ответственной стороны.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "reason": {
          "description": "Кодированное обозначение причины события - указывает причину наступления события, описываемого этим сообщением.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "response": {
          "description": "Информация о сообщении, на которое это сообщение является ответом.",
          "$ref": "#/definitions/MessageHeader_Response"
        },
        "focus": {
          "description": "Непосредственно сами данные сообщения - ссылка на корневой/целевой класс события.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "definition": {
          "description": "Permanent link to the MessageDefinition for this message.",
          "$ref": "canonical.schema.json#/definitions/canonical"
        }
      },
      "additionalProperties": false,
      "required": [
        "source",
        "resourceType"
      ]
    },
    "MessageHeader_Destination": {
      "description": "Заголовок сообщения обмена, которое либо запрашивает, либо отвечает на действие. Reference(s), являющиеся субъектами этого действия, также как и другая информация, связанная с этим действием, обычно передаются в виде комплекта, в котором первым идёт экземпляр ресурса MessageHeader.",
      "properties": {
        "id": {
          "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
          "$ref": "string.schema.json#/definitions/string"
        },
        "extension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
          "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 element and that modifies the understanding of the element in which it is contained. 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 can 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"
        },
        "name": {
          "description": "Человекочитаемое название целевой системы.",
          "$ref": "#/definitions/string"
        },
        "_name": {
          "description": "Extensions for name",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "target": {
          "description": "Указывает целевую конечную систему в ситуациях, когда первоначально сообщение было передано промежуточной системе.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "endpoint": {
          "description": "Указывает, куда должно быть направлено сообщение.",
          "$ref": "#/definitions/url"
        },
        "_endpoint": {
          "description": "Extensions for endpoint",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "receiver": {
          "description": "Позволяет данные, передаваемые в сообщении, адресовать конкретному человеку или отделению, когда направления конкретному приложению не достаточно.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        }
      },
      "additionalProperties": false
    },
    "MessageHeader_Source": {
      "description": "Заголовок сообщения обмена, которое либо запрашивает, либо отвечает на действие. Reference(s), являющиеся субъектами этого действия, также как и другая информация, связанная с этим действием, обычно передаются в виде комплекта, в котором первым идёт экземпляр ресурса MessageHeader.",
      "properties": {
        "id": {
          "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
          "$ref": "string.schema.json#/definitions/string"
        },
        "extension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
          "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 element and that modifies the understanding of the element in which it is contained. 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 can 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"
        },
        "name": {
          "description": "Человекочитаемое название исходной системы.",
          "$ref": "#/definitions/string"
        },
        "_name": {
          "description": "Extensions for name",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "software": {
          "description": "Может включать конфигурацию или другую информацию, полезную при отладке.",
          "$ref": "#/definitions/string"
        },
        "_software": {
          "description": "Extensions for software",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "version": {
          "description": "Может передавать версии нескольких систем в ситуациях, когда сообщение проходит через несколько рук.",
          "$ref": "#/definitions/string"
        },
        "_version": {
          "description": "Extensions for version",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "contact": {
          "description": "Адрес электронной почты, телефон, веб-сайт или другая контактная информация для связи по вопросам решения проблем.",
          "$ref": "ContactPoint.schema.json#/definitions/ContactPoint"
        },
        "endpoint": {
          "description": "Идентифицирует цель маршрута для отправки подтверждений.",
          "$ref": "#/definitions/url"
        },
        "_endpoint": {
          "description": "Extensions for endpoint",
          "$ref": "Element.schema.json#/definitions/Element"
        }
      },
      "additionalProperties": false
    },
    "MessageHeader_Response": {
      "description": "Заголовок сообщения обмена, которое либо запрашивает, либо отвечает на действие. Reference(s), являющиеся субъектами этого действия, также как и другая информация, связанная с этим действием, обычно передаются в виде комплекта, в котором первым идёт экземпляр ресурса MessageHeader.",
      "properties": {
        "id": {
          "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
          "$ref": "string.schema.json#/definitions/string"
        },
        "extension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
          "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 element and that modifies the understanding of the element in which it is contained. 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 can 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"
        },
        "identifier": {
          "description": "The MessageHeader.id of the message to which this message is a response.",
          "$ref": "#/definitions/id"
        },
        "_identifier": {
          "description": "Extensions for identifier",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "code": {
          "description": "Код, идентифицирующий тип ответа на сообщение - было ли оно успешным или нет, и следует ли его переслать повторно или нет.",
          "enum": [
            "ok",
            "transient-error",
            "fatal-error"
          ]
        },
        "_code": {
          "description": "Extensions for code",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "details": {
          "description": "Полное описание всех проблем, найденных в сообщении.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        }
      },
      "additionalProperties": false
    }
  }
}