8.26.10 JSON Schema for ObservationDefinition

Orders and Observations Work Group

Maturity Level: N/A

Standards 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": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
          "$ref": "Meta.schema.json#/definitions/Meta"
        },
        "implicitRules": {
          "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. 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": "The base language in which the resource is written.",
          "$ref": "#/definitions/code"
        },
        "_language": {
          "description": "Extensions for language",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "text": {
          "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
          "$ref": "Narrative.schema.json#/definitions/Narrative"
        },
        "contained": {
          "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope.",
          "items": {
            "$ref": "ResourceList.schema.json#/definitions/ResourceList"
          },
          "type": "array"
        },
        "extension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the resource. 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 resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. 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"
        },
        "url": {
          "description": "An absolute URL that is used to identify this ObservationDefinition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this ObservationDefinition is (or will be) published. The URL SHOULD include the major version of the ObservationDefinition. For more information see Technical and Business Versions.",
          "$ref": "#/definitions/uri"
        },
        "_url": {
          "description": "Extensions for url",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "identifier": {
          "description": "Business identifiers assigned to this ObservationDefinition. by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.",
          "$ref": "Identifier.schema.json#/definitions/Identifier"
        },
        "version": {
          "description": "The identifier that is used to identify this version of the ObservationDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the ObservationDefinition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable.",
          "$ref": "#/definitions/string"
        },
        "_version": {
          "description": "Extensions for version",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "name": {
          "description": "A natural language name identifying the ObservationDefinition. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
          "$ref": "#/definitions/string"
        },
        "_name": {
          "description": "Extensions for name",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "title": {
          "description": "A short, descriptive, user-friendly title for the ObservationDefinition.",
          "$ref": "#/definitions/string"
        },
        "_title": {
          "description": "Extensions for title",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "status": {
          "description": "The current state of the ObservationDefinition.",
          "$ref": "#/definitions/code"
        },
        "_status": {
          "description": "Extensions for status",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "experimental": {
          "description": "A flag to indicate that this ObservationDefinition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
          "$ref": "#/definitions/boolean"
        },
        "_experimental": {
          "description": "Extensions for experimental",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "date": {
          "description": "The date (and optionally time) when the ObservationDefinition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the ObservationDefinition changes.",
          "$ref": "#/definitions/dateTime"
        },
        "_date": {
          "description": "Extensions for date",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "publisher": {
          "description": "Helps establish the \"authority/credibility\" of the ObservationDefinition. May also allow for contact.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "contact": {
          "description": "Contact details to assist a user in finding and communicating with the publisher.",
          "items": {
            "$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
          },
          "type": "array"
        },
        "description": {
          "description": "A free text natural language description of the ObservationDefinition from the consumer\u0027s perspective.",
          "$ref": "#/definitions/markdown"
        },
        "_description": {
          "description": "Extensions for description",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "useContext": {
          "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate ObservationDefinition instances.",
          "items": {
            "$ref": "UsageContext.schema.json#/definitions/UsageContext"
          },
          "type": "array"
        },
        "jurisdiction": {
          "description": "A jurisdiction in which the ObservationDefinition is intended to be used.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "purpose": {
          "description": "Explains why this ObservationDefinition is needed and why it has been designed as it has.",
          "$ref": "#/definitions/markdown"
        },
        "_purpose": {
          "description": "Extensions for purpose",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "copyright": {
          "description": "Copyright statement relating to the ObservationDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the ObservationDefinition.",
          "$ref": "#/definitions/markdown"
        },
        "_copyright": {
          "description": "Extensions for copyright",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "approvalDate": {
          "description": "The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
          "$ref": "#/definitions/date"
        },
        "_approvalDate": {
          "description": "Extensions for approvalDate",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "lastReviewDate": {
          "description": "The date on which the asset content was last reviewed. Review happens periodically after that, but doesn\u0027t change the original approval date.",
          "$ref": "#/definitions/date"
        },
        "_lastReviewDate": {
          "description": "Extensions for lastReviewDate",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "effectivePeriod": {
          "description": "The period during which the ObservationDefinition content was or is planned to be effective.",
          "$ref": "Period.schema.json#/definitions/Period"
        },
        "derivedFromCanonical": {
          "description": "The canonical URL pointing to another FHIR-defined ObservationDefinition that is adhered to in whole or in part by this definition.",
          "items": {
            "$ref": "canonical.schema.json#/definitions/canonical"
          },
          "type": "array"
        },
        "derivedFromUri": {
          "description": "The URL pointing to an externally-defined observation definition, guideline or other definition that is adhered to in whole or in part by this definition.",
          "items": {
            "$ref": "#/definitions/uri"
          },
          "type": "array"
        },
        "_derivedFromUri": {
          "description": "Extensions for derivedFromUri",
          "items": {
            "$ref": "Element.schema.json#/definitions/Element"
          },
          "type": "array"
        },
        "subject": {
          "description": "A code that describes the intended kind of subject of Observation instances conforming to this ObservationDefinition.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "performerType": {
          "description": "The type of individual/organization/device that is expected to act upon instances of this definition.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "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"
        },
        "permittedDataType": {
          "description": "The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.",
          "items": {
            "$ref": "#/definitions/code"
          },
          "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"
        },
        "bodySite": {
          "description": "The site on the subject\u0027s body where the  observation is to be made.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "method": {
          "description": "The method or technique used to perform the observation.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "specimen": {
          "description": "The kind of specimen that this type of observation is produced on.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "device": {
          "description": "The measurement model of device or actual device used to produce observations of this type.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "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 observations conforming to this ObservationDefinition.",
          "$ref": "#/definitions/ObservationDefinition_QuantitativeDetails"
        },
        "qualifiedValue": {
          "description": "A set of qualified values associated with a context and a set of conditions -  provides a range for quantitative and ordinal observations and a collection of value sets for qualitative observations.",
          "items": {
            "$ref": "#/definitions/ObservationDefinition_QualifiedValue"
          },
          "type": "array"
        },
        "hasMember": {
          "description": "This ObservationDefinition defines a group  observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "component": {
          "description": "Some observations have multiple component observations, expressed as separate code value pairs.",
          "items": {
            "$ref": "#/definitions/ObservationDefinition_Component"
          },
          "type": "array"
        }
      },
      "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 and/or the understanding of the containing element\u0027s descendants. 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"
        },
        "unit": {
          "description": "Primary unit used to report quantitative results of observations conforming to this ObservationDefinition.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "customaryUnit": {
          "description": "Secondary 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 primary unit to value expressed with secondary 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_QualifiedValue": {
      "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 and/or the understanding of the containing element\u0027s descendants. 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"
        },
        "context": {
          "description": "A concept defining the context for this set of qualified values.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "appliesTo": {
          "description": "The target population this  set of qualified values applies to.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "gender": {
          "description": "The gender this  set of qualified values applies to.",
          "$ref": "#/definitions/code"
        },
        "_gender": {
          "description": "Extensions for gender",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "age": {
          "description": "The age range this  set of qualified values applies to.",
          "$ref": "Range.schema.json#/definitions/Range"
        },
        "gestationalAge": {
          "description": "The gestational age this  set of qualified values applies to.",
          "$ref": "Range.schema.json#/definitions/Range"
        },
        "condition": {
          "description": "Text based condition for which the the set of qualified values is valid.",
          "$ref": "#/definitions/string"
        },
        "_condition": {
          "description": "Extensions for condition",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "rangeCategory": {
          "description": "The category of range of values for continuous or ordinal observations that match the criteria of this set of qualified values.",
          "$ref": "#/definitions/code"
        },
        "_rangeCategory": {
          "description": "Extensions for rangeCategory",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "range": {
          "description": "The range of values defined for continuous or ordinal observations that match the criteria of this set of qualified values.",
          "$ref": "Range.schema.json#/definitions/Range"
        },
        "validCodedValueSet": {
          "description": "The set of valid coded results for qualitative observations  that match the criteria of this set of qualified values.",
          "$ref": "canonical.schema.json#/definitions/canonical"
        },
        "normalCodedValueSet": {
          "description": "The set of normal coded results for qualitative observations  that match the criteria of this set of qualified values.",
          "$ref": "canonical.schema.json#/definitions/canonical"
        },
        "abnormalCodedValueSet": {
          "description": "The set of abnormal coded results for qualitative observations  that match the criteria of this set of qualified values.",
          "$ref": "canonical.schema.json#/definitions/canonical"
        },
        "criticalCodedValueSet": {
          "description": "The set of critical coded results for qualitative observations  that match the criteria of this set of qualified values.",
          "$ref": "canonical.schema.json#/definitions/canonical"
        }
      },
      "additionalProperties": false
    },
    "ObservationDefinition_Component": {
      "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 and/or the understanding of the containing element\u0027s descendants. 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": "Describes what will be observed.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "permittedDataType": {
          "description": "The data types allowed for the value element of the instance of this component observations.",
          "items": {
            "$ref": "#/definitions/code"
          },
          "type": "array"
        },
        "_permittedDataType": {
          "description": "Extensions for permittedDataType",
          "items": {
            "$ref": "Element.schema.json#/definitions/Element"
          },
          "type": "array"
        },
        "quantitativeDetails": {
          "description": "Characteristics for quantitative results of this observation.",
          "$ref": "#/definitions/ObservationDefinition_QuantitativeDetails"
        },
        "qualifiedValue": {
          "description": "A set of qualified values associated with a context and a set of conditions -  provides a range for quantitative and ordinal observations and a collection of value sets for qualitative observations.",
          "items": {
            "$ref": "#/definitions/ObservationDefinition_QualifiedValue"
          },
          "type": "array"
        }
      },
      "additionalProperties": false,
      "required": [
        "code"
      ]
    }
  }
}