Current Build

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

2.42 JSON Schema for DocumentReference

Structured Documents Work GroupMaturity Level: N/ABallot Status: Informative Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson

This is a representation of the json schema for DocumentReference, 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/DocumentReference",
  "$ref": "#/definitions/DocumentReference",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "DocumentReference": {
      "description": "A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.",
      "properties": {
        "resourceType": {
          "description": "This is a DocumentReference resource",
          "const": "DocumentReference"
        },
        "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"
        },
        "masterIdentifier": {
          "description": "Идентификатор документа, назначенный источником этого документа. Этот идентификатор специфичен для данной версии документа. Этот уникальный идентификатор может использоваться в других местах для указания на эту версию документа.",
          "$ref": "Identifier.schema.json#/definitions/Identifier"
        },
        "identifier": {
          "description": "Другие идентификаторы, ассоциированные с документом, включая версионно-независимые идентификаторы.",
          "items": {
            "$ref": "Identifier.schema.json#/definitions/Identifier"
          },
          "type": "array"
        },
        "status": {
          "description": "Статус документа.",
          "enum": [
            "current",
            "superseded",
            "entered-in-error"
          ]
        },
        "_status": {
          "description": "Extensions for status",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "docStatus": {
          "description": "Статус лежащего в основе документа.",
          "$ref": "#/definitions/code"
        },
        "_docStatus": {
          "description": "Extensions for docStatus",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "type": {
          "description": "Определяет конкретный вид документа (например анамнез и физикальный осмотр, выписной эпикриз, текущие заметки). Как правило, он совпадает с целью составления этого документа.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "category": {
          "description": "Классификация типа документа - содействует индексации и поиску. Может подразумеваться или вытекать из кода, указанного в элементе DocumentReference.type.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "subject": {
          "description": "О ком или о чем этот документ. Документ может быть о человеке (пациент или медицинский работник), об устройстве (т. е. машине) или даже о группе субъектов (например документ о стаде сельскохозяйственных животных, или документ о ряде пациентов, испытавших общее воздействие).",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "date": {
          "description": "Когда этот document reference был создан.",
          "$ref": "#/definitions/instant"
        },
        "_date": {
          "description": "Extensions for date",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "author": {
          "description": "Определяет, кто ответственен за добавление информации в документ.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "authenticator": {
          "description": "Какое лицо или организация удостоверяет, что это документ действителен.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "custodian": {
          "description": "Определяет организацию или группу, которая несет ответственность за текущее обслуживание и доступ к документу.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "relatesTo": {
          "description": "Взаимосвязи этого документа с другими существующими document references.",
          "items": {
            "$ref": "#/definitions/DocumentReference_RelatesTo"
          },
          "type": "array"
        },
        "description": {
          "description": "Human-readable description of the source document.",
          "$ref": "#/definitions/string"
        },
        "_description": {
          "description": "Extensions for description",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "securityLabel": {
          "description": "A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the \"reference\" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "content": {
          "description": "Документ и формат. Допустимо повторение элемента \"content\" с указанием разных форматов.",
          "items": {
            "$ref": "#/definitions/DocumentReference_Content"
          },
          "type": "array"
        },
        "context": {
          "description": "Клинический контекст, в котором документ был подготовлен.",
          "$ref": "#/definitions/DocumentReference_Context"
        }
      },
      "additionalProperties": false,
      "required": [
        "content",
        "resourceType"
      ]
    },
    "DocumentReference_RelatesTo": {
      "description": "A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.",
      "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"
        },
        "code": {
          "description": "Тип взаимосвязи этого документа с другим документом.",
          "enum": [
            "replaces",
            "transforms",
            "signs",
            "appends"
          ]
        },
        "_code": {
          "description": "Extensions for code",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "target": {
          "description": "Целевой документ этой взаимосвязи.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        }
      },
      "additionalProperties": false,
      "required": [
        "target"
      ]
    },
    "DocumentReference_Content": {
      "description": "A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.",
      "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"
        },
        "attachment": {
          "description": "Документ или URL-адрес документа вместе с важными метаданными для подтверждения целостности содержимого.",
          "$ref": "Attachment.schema.json#/definitions/Attachment"
        },
        "format": {
          "description": "Идентификатор, определяющий кодировку документа, структуру и шаблон, которому соответствует документ помимо базового формата, указанного в mimeType.",
          "$ref": "Coding.schema.json#/definitions/Coding"
        }
      },
      "additionalProperties": false,
      "required": [
        "attachment"
      ]
    },
    "DocumentReference_Context": {
      "description": "A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.",
      "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"
        },
        "encounter": {
          "description": "Описывает случай клинического обслуживания или вид помощи, с которым связано содержимое документа.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "event": {
          "description": "Этот перечень кодов представляет собой задокументированные основные клинические акты, например колоноскопия или аппендэктомия. В некоторых случаях событие берется из typeCode, например \"History and Physical Report\", в котором документируемой процедурой обязательно будет акт \"History and Physical\".",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "period": {
          "description": "Период времени, в течение которого услуга, которая описана в документе, была предоставлена.",
          "$ref": "Period.schema.json#/definitions/Period"
        },
        "facilityType": {
          "description": "Вид заведения, где наблюдался пациент.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "practiceSetting": {
          "description": "Это свойство может передавать подробности рабочих условий, в которых был создан контент, часто отражающие клиническую специальность.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "sourcePatientInfo": {
          "description": "Информация о пациенте, известная на момент публикации документа. Может быть ссылкой на конкретную версию или вложенный ресурс.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "related": {
          "description": "Связанные идентификаторы или ресурсы, сопутствующие данному DocumentReference.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        }
      },
      "additionalProperties": false
    }
  }
}