Release 4
DiagnosticsThis page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU) in it's permanent home (it will always be available at this URL). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4
| Orders and Observations Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson |
This is a representation of the json schema for Observation, 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/Observation",
"$ref": "#/definitions/Observation",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"Observation": {
"description": "Measurements and simple assertions made about a patient, device or other subject.",
"properties": {
"resourceType": {
"description": "This is a Observation resource",
"const": "Observation"
},
"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, and 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"
},
"identifier": {
"description": "A unique identifier assigned to this observation.",
"items": {
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"type": "array"
},
"basedOn": {
"description": "A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"partOf": {
"description": "A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"status": {
"description": "The status of the result value.",
"enum": [
"registered",
"preliminary",
"final",
"amended",
"corrected",
"cancelled",
"entered-in-error",
"unknown"
]
},
"_status": {
"description": "Extensions for status",
"$ref": "Element.schema.json#/definitions/Element"
},
"category": {
"description": "A code that classifies the general type of observation being made.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"code": {
"description": "Describes what was observed. Sometimes this is called the observation \"name\".",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"subject": {
"description": "The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"focus": {
"description": "The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother\u0027s record. The focus of an observation could also be an existing condition, an intervention, the subject\u0027s diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child\u0027s tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"encounter": {
"description": "The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"effectiveDateTime": {
"description": "The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the \"physiologically relevant time\". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.",
"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"
},
"_effectiveDateTime": {
"description": "Extensions for effectiveDateTime",
"$ref": "Element.schema.json#/definitions/Element"
},
"effectivePeriod": {
"description": "The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the \"physiologically relevant time\". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.",
"$ref": "Period.schema.json#/definitions/Period"
},
"effectiveTiming": {
"description": "The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the \"physiologically relevant time\". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.",
"$ref": "Timing.schema.json#/definitions/Timing"
},
"effectiveInstant": {
"description": "The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the \"physiologically relevant time\". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.",
"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"
},
"_effectiveInstant": {
"description": "Extensions for effectiveInstant",
"$ref": "Element.schema.json#/definitions/Element"
},
"issued": {
"description": "The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.",
"$ref": "#/definitions/instant"
},
"_issued": {
"description": "Extensions for issued",
"$ref": "Element.schema.json#/definitions/Element"
},
"performer": {
"description": "Who was responsible for asserting the observed value as \"true\".",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"valueQuantity": {
"description": "The information determined as a result of making the observation, if the information has a simple value.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"valueCodeableConcept": {
"description": "The information determined as a result of making the observation, if the information has a simple value.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"valueString": {
"description": "The information determined as a result of making the observation, if the information has a simple value.",
"pattern": "^[ \\r\\n\\t\\S]+$",
"type": "string"
},
"_valueString": {
"description": "Extensions for valueString",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueBoolean": {
"description": "The information determined as a result of making the observation, if the information has a simple value.",
"pattern": "^true|false$",
"type": "boolean"
},
"_valueBoolean": {
"description": "Extensions for valueBoolean",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueInteger": {
"description": "The information determined as a result of making the observation, if the information has a simple value.",
"pattern": "^-?([0]|([1-9][0-9]*))$",
"type": "number"
},
"_valueInteger": {
"description": "Extensions for valueInteger",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueRange": {
"description": "The information determined as a result of making the observation, if the information has a simple value.",
"$ref": "Range.schema.json#/definitions/Range"
},
"valueRatio": {
"description": "The information determined as a result of making the observation, if the information has a simple value.",
"$ref": "Ratio.schema.json#/definitions/Ratio"
},
"valueSampledData": {
"description": "The information determined as a result of making the observation, if the information has a simple value.",
"$ref": "SampledData.schema.json#/definitions/SampledData"
},
"valueTime": {
"description": "The information determined as a result of making the observation, if the information has a simple value.",
"pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?$",
"type": "string"
},
"_valueTime": {
"description": "Extensions for valueTime",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueDateTime": {
"description": "The information determined as a result of making the observation, if the information has a simple value.",
"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"
},
"_valueDateTime": {
"description": "Extensions for valueDateTime",
"$ref": "Element.schema.json#/definitions/Element"
},
"valuePeriod": {
"description": "The information determined as a result of making the observation, if the information has a simple value.",
"$ref": "Period.schema.json#/definitions/Period"
},
"dataAbsentReason": {
"description": "Provides a reason why the expected value in the element Observation.value[x] is missing.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"interpretation": {
"description": "A categorical assessment of an observation value. For example, high, low, normal.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"note": {
"description": "Comments about the observation or the results.",
"items": {
"$ref": "Annotation.schema.json#/definitions/Annotation"
},
"type": "array"
},
"bodySite": {
"description": "Indicates the site on the subject\u0027s body where the observation was made (i.e. the target site).",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"method": {
"description": "Indicates the mechanism used to perform the observation.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"specimen": {
"description": "The specimen that was used when this observation was made.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"device": {
"description": "The device used to generate the observation data.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"referenceRange": {
"description": "Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an \"OR\". In other words, to represent two distinct target populations, two `referenceRange` elements would be used.",
"items": {
"$ref": "#/definitions/Observation_ReferenceRange"
},
"type": "array"
},
"hasMember": {
"description": "This observation is 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"
},
"derivedFrom": {
"description": "The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"component": {
"description": "Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.",
"items": {
"$ref": "#/definitions/Observation_Component"
},
"type": "array"
}
},
"additionalProperties": false,
"required": [
"code",
"resourceType"
]
},
"Observation_ReferenceRange": {
"description": "Measurements and simple assertions made about a patient, device or other subject.",
"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"
},
"low": {
"description": "The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is \u003e\u003d5 - \u003c\u003d9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is \u003c\u003d2.3).",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"high": {
"description": "The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is \u003e\u003d5 - \u003c\u003d9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is \u003e\u003d 2.3).",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"type": {
"description": "Codes to indicate the what part of the targeted reference population it 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. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an \"AND\" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"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"
},
"text": {
"description": "Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of \"Negative\" or a list or table of \"normals\".",
"$ref": "#/definitions/string"
},
"_text": {
"description": "Extensions for text",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"additionalProperties": false
},
"Observation_Component": {
"description": "Measurements and simple assertions made about a patient, device or other subject.",
"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 was observed. Sometimes this is called the observation \"code\".",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"valueQuantity": {
"description": "The information determined as a result of making the observation, if the information has a simple value.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"valueCodeableConcept": {
"description": "The information determined as a result of making the observation, if the information has a simple value.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"valueString": {
"description": "The information determined as a result of making the observation, if the information has a simple value.",
"pattern": "^[ \\r\\n\\t\\S]+$",
"type": "string"
},
"_valueString": {
"description": "Extensions for valueString",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueBoolean": {
"description": "The information determined as a result of making the observation, if the information has a simple value.",
"pattern": "^true|false$",
"type": "boolean"
},
"_valueBoolean": {
"description": "Extensions for valueBoolean",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueInteger": {
"description": "The information determined as a result of making the observation, if the information has a simple value.",
"pattern": "^-?([0]|([1-9][0-9]*))$",
"type": "number"
},
"_valueInteger": {
"description": "Extensions for valueInteger",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueRange": {
"description": "The information determined as a result of making the observation, if the information has a simple value.",
"$ref": "Range.schema.json#/definitions/Range"
},
"valueRatio": {
"description": "The information determined as a result of making the observation, if the information has a simple value.",
"$ref": "Ratio.schema.json#/definitions/Ratio"
},
"valueSampledData": {
"description": "The information determined as a result of making the observation, if the information has a simple value.",
"$ref": "SampledData.schema.json#/definitions/SampledData"
},
"valueTime": {
"description": "The information determined as a result of making the observation, if the information has a simple value.",
"pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?$",
"type": "string"
},
"_valueTime": {
"description": "Extensions for valueTime",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueDateTime": {
"description": "The information determined as a result of making the observation, if the information has a simple value.",
"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"
},
"_valueDateTime": {
"description": "Extensions for valueDateTime",
"$ref": "Element.schema.json#/definitions/Element"
},
"valuePeriod": {
"description": "The information determined as a result of making the observation, if the information has a simple value.",
"$ref": "Period.schema.json#/definitions/Period"
},
"dataAbsentReason": {
"description": "Provides a reason why the expected value in the element Observation.component.value[x] is missing.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"interpretation": {
"description": "A categorical assessment of an observation value. For example, high, low, normal.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"referenceRange": {
"description": "Guidance on how to interpret the value by comparison to a normal or recommended range.",
"items": {
"$ref": "#/definitions/Observation_ReferenceRange"
},
"type": "array"
}
},
"additionalProperties": false,
"required": [
"code"
]
}
}
}
®© HL7.org 2011+. FHIR Release 4 (Technical Correction #1) (v4.0.1) generated on Fri, Nov 1, 2019 09:36+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to R3 |
|
Propose a change