Current Build

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

8.32 JSON Schema for ObservationDefinition

Orders and Observations Work GroupMaturity Level: N/ABallot Status: Informative Compartments: Not linked to any defined compartments

This is a representation of the json schema for ObservationDefinition, 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/ObservationDefinition",
  "$ref": "#/definitions/ObservationDefinition",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "ObservationDefinition": {
      "description": "Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.",
      "properties": {
        "resourceType": {
          "description": "This is a ObservationDefinition resource",
          "const": "ObservationDefinition"
        },
        "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"
        },
        "category": {
          "description": "A code that classifies the general type of observation.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "code": {
          "description": "Describes what will be observed. Sometimes this is called the observation \"name\".",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "identifier": {
          "description": "A unique identifier assigned to this ObservationDefinition artifact.",
          "items": {
            "$ref": "Identifier.schema.json#/definitions/Identifier"
          },
          "type": "array"
        },
        "permittedDataType": {
          "description": "The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.",
          "items": {
            "enum": [
              "Quantity",
              "CodeableConcept",
              "string",
              "boolean",
              "integer",
              "Range",
              "Ratio",
              "SampledData",
              "time",
              "dateTime",
              "Period"
            ]
          },
          "type": "array"
        },
        "_permittedDataType": {
          "description": "Extensions for permittedDataType",
          "items": {
            "$ref": "Element.schema.json#/definitions/Element"
          },
          "type": "array"
        },
        "multipleResultsAllowed": {
          "description": "Multiple results allowed for observations conforming to this ObservationDefinition.",
          "$ref": "#/definitions/boolean"
        },
        "_multipleResultsAllowed": {
          "description": "Extensions for multipleResultsAllowed",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "method": {
          "description": "The method or technique used to perform the observation.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "preferredReportName": {
          "description": "The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.",
          "$ref": "#/definitions/string"
        },
        "_preferredReportName": {
          "description": "Extensions for preferredReportName",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "quantitativeDetails": {
          "description": "Characteristics for quantitative results of this observation.",
          "$ref": "#/definitions/ObservationDefinition_QuantitativeDetails"
        },
        "qualifiedInterval": {
          "description": "Multiple  ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition.",
          "items": {
            "$ref": "#/definitions/ObservationDefinition_QualifiedInterval"
          },
          "type": "array"
        },
        "validCodedValueSet": {
          "description": "The set of valid coded results for the observations  conforming to this ObservationDefinition.",
          "$ref": "#/definitions/uri"
        },
        "_validCodedValueSet": {
          "description": "Extensions for validCodedValueSet",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "normalCodedValueSet": {
          "description": "The set of normal coded results for the observations conforming to this ObservationDefinition.",
          "$ref": "#/definitions/uri"
        },
        "_normalCodedValueSet": {
          "description": "Extensions for normalCodedValueSet",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "abnormalCodedValueSet": {
          "description": "The set of abnormal coded results for the observation conforming to this ObservationDefinition.",
          "$ref": "#/definitions/uri"
        },
        "_abnormalCodedValueSet": {
          "description": "Extensions for abnormalCodedValueSet",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "criticalCodedValueSet": {
          "description": "The set of critical coded results for the observation conforming to this ObservationDefinition.",
          "$ref": "#/definitions/uri"
        },
        "_criticalCodedValueSet": {
          "description": "Extensions for criticalCodedValueSet",
          "$ref": "Element.schema.json#/definitions/Element"
        }
      },
      "additionalProperties": false,
      "required": [
        "code",
        "resourceType"
      ]
    },
    "ObservationDefinition_QuantitativeDetails": {
      "description": "Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.",
      "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"
        },
        "customaryUnit": {
          "description": "Customary unit used to report quantitative results of observations conforming to this ObservationDefinition.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "unit": {
          "description": "SI unit used to report quantitative results of observations conforming to this ObservationDefinition.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "conversionFactor": {
          "description": "Factor for converting value expressed with SI unit to value expressed with customary unit.",
          "$ref": "#/definitions/decimal"
        },
        "_conversionFactor": {
          "description": "Extensions for conversionFactor",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "decimalPrecision": {
          "description": "Number of digits after decimal separator when the results of such observations are of type Quantity.",
          "$ref": "#/definitions/integer"
        },
        "_decimalPrecision": {
          "description": "Extensions for decimalPrecision",
          "$ref": "Element.schema.json#/definitions/Element"
        }
      },
      "additionalProperties": false
    },
    "ObservationDefinition_QualifiedInterval": {
      "description": "Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.",
      "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"
        },
        "category": {
          "description": "The category of interval of values for continuous or ordinal observations conforming to this ObservationDefinition.",
          "enum": [
            "reference",
            "critical",
            "absolute"
          ]
        },
        "_category": {
          "description": "Extensions for category",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "range": {
          "description": "The low and high values determining the interval. There may be only one of the two.",
          "$ref": "Range.schema.json#/definitions/Range"
        },
        "context": {
          "description": "Codes to indicate the health context the range applies to. For example, the normal or therapeutic range.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "appliesTo": {
          "description": "Codes to indicate the target population this reference range applies to.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "gender": {
          "description": "Sex of the population the range applies to.",
          "enum": [
            "male",
            "female",
            "other",
            "unknown"
          ]
        },
        "_gender": {
          "description": "Extensions for gender",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "age": {
          "description": "The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.",
          "$ref": "Range.schema.json#/definitions/Range"
        },
        "gestationalAge": {
          "description": "The gestational age to which this reference range is applicable, in the context of pregnancy.",
          "$ref": "Range.schema.json#/definitions/Range"
        },
        "condition": {
          "description": "Text based condition for which the reference range is valid.",
          "$ref": "#/definitions/string"
        },
        "_condition": {
          "description": "Extensions for condition",
          "$ref": "Element.schema.json#/definitions/Element"
        }
      },
      "additionalProperties": false
    }
  }
}