Release 4B
This page is part of the FHIR Specification (v4.3.0: R4B - STU). 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: 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.
Administration
{
"$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": "string.schema.json#/definitions/string"
},
"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"
},
"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": {
"$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"
},
"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": "Reference.schema.json#/definitions/Reference"
},
"normalCodedValueSet": {
"description": "The set of normal coded results for the observations conforming to this ObservationDefinition.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"abnormalCodedValueSet": {
"description": "The set of abnormal coded results for the observation conforming to this ObservationDefinition.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"criticalCodedValueSet": {
"description": "The set of critical coded results for the observation conforming to this ObservationDefinition.",
"$ref": "Reference.schema.json#/definitions/Reference"
}
},
"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"
},
"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 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"
},
"category": {
"description": "The category of interval of values for continuous or ordinal observations conforming to this ObservationDefinition.",
"$ref": "#/definitions/code"
},
"_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.",
"$ref": "#/definitions/code"
},
"_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
}
}
}
FHIR ®© HL7.org 2011+. FHIR Release 4B (v4.3.0) hl7.fhir.r4b.core#4.3.0 generated on Sat, May 28, 2022 12:56+1000.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change