Current Build

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

11.17 JSON Schema for Immunization

Public Health and Emergency Response Work GroupMaturity Level: N/ABallot Status: Informative Compartments: Patient, Practitioner

This is a representation of the json schema for Immunization, 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/Immunization",
  "$ref": "#/definitions/Immunization",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "Immunization": {
      "description": "Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.",
      "properties": {
        "resourceType": {
          "description": "This is a Immunization resource",
          "const": "Immunization"
        },
        "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"
        },
        "identifier": {
          "description": "Уникальный идентификатор, присвоенный конкретно этой записи о рекомендации.",
          "items": {
            "$ref": "Identifier.schema.json#/definitions/Identifier"
          },
          "type": "array"
        },
        "status": {
          "description": "Показывает текущий статус события вакцинации.",
          "$ref": "#/definitions/code"
        },
        "_status": {
          "description": "Extensions for status",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "statusReason": {
          "description": "Indicates the reason the immunization event was not performed.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "vaccineCode": {
          "description": "Вакцина, которая была введена или должна была быть введена.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "patient": {
          "description": "Пациент, который получил или не получил иммунизацию.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "encounter": {
          "description": "Визит, госпитализация или другой вид контакта пациента и поставщика медицинского обслуживания, в рамках которого проведена иммунизация.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "occurrenceDateTime": {
          "description": "Дата, когда вакцина была введена или должна была быть введена.",
          "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$",
          "type": "string"
        },
        "_occurrenceDateTime": {
          "description": "Extensions for occurrenceDateTime",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "occurrenceString": {
          "description": "Дата, когда вакцина была введена или должна была быть введена.",
          "pattern": "^[ \\r\\n\\t\\S]+$",
          "type": "string"
        },
        "_occurrenceString": {
          "description": "Extensions for occurrenceString",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "recorded": {
          "description": "The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.",
          "$ref": "#/definitions/dateTime"
        },
        "_recorded": {
          "description": "Extensions for recorded",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "primarySource": {
          "description": "An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.",
          "$ref": "#/definitions/boolean"
        },
        "_primarySource": {
          "description": "Extensions for primarySource",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "reportOrigin": {
          "description": "The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "location": {
          "description": "Место оказания услуги, где произошла вакцинация.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "manufacturer": {
          "description": "Название производителя вакцины.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "lotNumber": {
          "description": "Номер партии вакцины.",
          "$ref": "#/definitions/string"
        },
        "_lotNumber": {
          "description": "Extensions for lotNumber",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "expirationDate": {
          "description": "Дата истечения годности вакцины.",
          "$ref": "#/definitions/date"
        },
        "_expirationDate": {
          "description": "Extensions for expirationDate",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "site": {
          "description": "Место на теле, куда ввели вакцину.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "route": {
          "description": "Пусть, который вакцинный продукт  прошел в теле.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "doseQuantity": {
          "description": "Количество вакцинного продукта, которое было введено.",
          "$ref": "Quantity.schema.json#/definitions/Quantity"
        },
        "performer": {
          "description": "Indicates who performed the immunization event.",
          "items": {
            "$ref": "#/definitions/Immunization_Performer"
          },
          "type": "array"
        },
        "note": {
          "description": "Дополнительная информация об иммунизации, не передаваемая другими полями.",
          "items": {
            "$ref": "Annotation.schema.json#/definitions/Annotation"
          },
          "type": "array"
        },
        "reasonCode": {
          "description": "Причины, по которым была введена вакцина.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "reasonReference": {
          "description": "Condition, Observation or DiagnosticReport that supports why the immunization was administered.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "isSubpotent": {
          "description": "Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.",
          "$ref": "#/definitions/boolean"
        },
        "_isSubpotent": {
          "description": "Extensions for isSubpotent",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "subpotentReason": {
          "description": "Reason why a dose is considered to be subpotent.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "education": {
          "description": "Educational material presented to the patient (or guardian) at the time of vaccine administration.",
          "items": {
            "$ref": "#/definitions/Immunization_Education"
          },
          "type": "array"
        },
        "programEligibility": {
          "description": "Indicates a patient\u0027s eligibility for a funding program.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "fundingSource": {
          "description": "Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "reaction": {
          "description": "Категорийные данные, обозначающие, что нежелательное побочное событие по времени связано с иммунизацией.",
          "items": {
            "$ref": "#/definitions/Immunization_Reaction"
          },
          "type": "array"
        },
        "protocolApplied": {
          "description": "The protocol (set of recommendations) being followed by the provider who administered the dose.",
          "items": {
            "$ref": "#/definitions/Immunization_ProtocolApplied"
          },
          "type": "array"
        }
      },
      "additionalProperties": false,
      "required": [
        "patient",
        "vaccineCode",
        "resourceType"
      ]
    },
    "Immunization_Performer": {
      "description": "Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.",
      "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"
        },
        "function": {
          "description": "Describes the type of performance (e.g. ordering provider, administering provider, etc.).",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "actor": {
          "description": "The practitioner or organization who performed the action.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        }
      },
      "additionalProperties": false,
      "required": [
        "actor"
      ]
    },
    "Immunization_Education": {
      "description": "Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.",
      "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"
        },
        "documentType": {
          "description": "Identifier of the material presented to the patient.",
          "$ref": "#/definitions/string"
        },
        "_documentType": {
          "description": "Extensions for documentType",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "reference": {
          "description": "Reference pointer to the educational material given to the patient if the information was on line.",
          "$ref": "#/definitions/uri"
        },
        "_reference": {
          "description": "Extensions for reference",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "publicationDate": {
          "description": "Date the educational material was published.",
          "$ref": "#/definitions/dateTime"
        },
        "_publicationDate": {
          "description": "Extensions for publicationDate",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "presentationDate": {
          "description": "Date the educational material was given to the patient.",
          "$ref": "#/definitions/dateTime"
        },
        "_presentationDate": {
          "description": "Extensions for presentationDate",
          "$ref": "Element.schema.json#/definitions/Element"
        }
      },
      "additionalProperties": false
    },
    "Immunization_Reaction": {
      "description": "Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.",
      "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"
        },
        "date": {
          "description": "Дата реакции на иммунизацию.",
          "$ref": "#/definitions/dateTime"
        },
        "_date": {
          "description": "Extensions for date",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "detail": {
          "description": "Подробные сведения о реакции.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "reported": {
          "description": "Флаг, что это реакция со слов пациента.",
          "$ref": "#/definitions/boolean"
        },
        "_reported": {
          "description": "Extensions for reported",
          "$ref": "Element.schema.json#/definitions/Element"
        }
      },
      "additionalProperties": false
    },
    "Immunization_ProtocolApplied": {
      "description": "Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.",
      "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"
        },
        "series": {
          "description": "Один из возможных путей достижения предполагаемого иммунитета к заболеванию - с контексте органа власти.",
          "$ref": "#/definitions/string"
        },
        "_series": {
          "description": "Extensions for series",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "authority": {
          "description": "Indicates the authority who published the protocol (e.g. ACIP) that is being followed.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "targetDisease": {
          "description": "The vaccine preventable disease the dose is being administered against.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "doseNumberPositiveInt": {
          "description": "Номинальная позиция в серии.",
          "pattern": "^[1-9][0-9]*$",
          "type": "number"
        },
        "_doseNumberPositiveInt": {
          "description": "Extensions for doseNumberPositiveInt",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "doseNumberString": {
          "description": "Номинальная позиция в серии.",
          "pattern": "^[ \\r\\n\\t\\S]+$",
          "type": "string"
        },
        "_doseNumberString": {
          "description": "Extensions for doseNumberString",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "seriesDosesPositiveInt": {
          "description": "Рекомендуемое количество доз для достижения иммунитета.",
          "pattern": "^[1-9][0-9]*$",
          "type": "number"
        },
        "_seriesDosesPositiveInt": {
          "description": "Extensions for seriesDosesPositiveInt",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "seriesDosesString": {
          "description": "Рекомендуемое количество доз для достижения иммунитета.",
          "pattern": "^[ \\r\\n\\t\\S]+$",
          "type": "string"
        },
        "_seriesDosesString": {
          "description": "Extensions for seriesDosesString",
          "$ref": "Element.schema.json#/definitions/Element"
        }
      },
      "additionalProperties": false
    }
  }
}