. Page versions: R5 R4B R4 R3 R2This page is part of the FHIR Specification (v0.0.82: DSTU 1). 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 R3 R2
Profile for observation
{
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"Measurements and simple assertions made about a patient, device or other subject.\" class=\"dict\" href=\"observation-definitions.html#Observation\"><b>Observation</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Describes what was observed. Sometimes this is called the observation "code".\" class=\"dict\" href=\"observation-definitions.html#Observation.name\"><b>name</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-observation-codes.html\">Type of observation (code / type)</a></span><span style=\"color: Gray\"> --></span></name>\r\n <<a title=\"The information determined as a result of making the observation, if the information has a simple value.\" class=\"dict\" href=\"observation-definitions.html#Observation.value_x_\"><b>value[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a>|<a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a>|<a href=\"datatypes.html#Attachment\">Attachment</a>|<a href=\"datatypes.html#Ratio\">Ratio</a>|<a href=\"datatypes.html#Period\">Period</a>|\r\n <a href=\"datatypes.html#SampledData\">SampledData</a>|<a href=\"datatypes.html#string\">string</a></span> <span style=\"color: navy\">Actual result</span><span style=\"color: Gray\"> --></span></value[x]>\r\n <<a title=\"The assessment made based on the result of the observation.\" class=\"dict\" href=\"observation-definitions.html#Observation.interpretation\"><b>interpretation</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-observation-interpretation.html\">High, low, normal, etc.</a></span><span style=\"color: Gray\"> --></span></interpretation>\r\n <<a title=\"May include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result.\" class=\"dict\" href=\"observation-definitions.html#Observation.comments\"><b>comments</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Comments about result</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"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.\" class=\"dict\" href=\"observation-definitions.html#Observation.applies_x_\"><b>applies[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a>|<a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">\r\n Physiologically Relevant time/time-period for observation</span><span style=\"color: Gray\"> --></span></applies[x]>\r\n <<a title=\"Date/Time this was made available.\" class=\"dict\" href=\"observation-definitions.html#Observation.issued\"><b>issued</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#instant\">instant</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Date/Time this was made available</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The status of the result value (this element modifies the meaning of other elements)\" class=\"dict\" href=\"observation-definitions.html#Observation.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"observation-status.html\">registered | preliminary | final | amended +</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"An estimate of the degree to which quality issues have impacted on the value reported (this element modifies the meaning of other elements)\" class=\"dict\" href=\"observation-definitions.html#Observation.reliability\"><span style=\"text-decoration: underline\"><b>reliability</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"observation-reliability.html\">ok | ongoing | early | questionable | calibrating | error +</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Indicates where on the subject's body the observation was made.\" class=\"dict\" href=\"observation-definitions.html#Observation.bodySite\"><b>bodySite</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-body-site.html\">Observed body part</a></span><span style=\"color: Gray\"> --></span></bodySite>\r\n <<a title=\"Indicates the mechanism used to perform the observation.\" class=\"dict\" href=\"observation-definitions.html#Observation.method\"><b>method</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-observation-methods.html\">How it was done</a></span><span style=\"color: Gray\"> --></span></method>\r\n <<a title=\"A unique identifier for the simple observation.\" class=\"dict\" href=\"observation-definitions.html#Observation.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Unique Id for this particular observation</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"The thing the observation is being made about.\" class=\"dict\" href=\"observation-definitions.html#Observation.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"group.html#Group\">Group</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">Who and/or what this is about</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"The specimen that was used when this observation was made.\" class=\"dict\" href=\"observation-definitions.html#Observation.specimen\"><b>specimen</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"specimen.html#Specimen\">Specimen</a>)</span> <span style=\"color: navy\">Specimen used for this observation</span><span style=\"color: Gray\"> --></span></specimen>\r\n <<a title=\"Who was responsible for asserting the observed value as "true".\" class=\"dict\" href=\"observation-definitions.html#Observation.performer\"><b>performer</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">Who did the observation</span><span style=\"color: Gray\"> --></span></performer>\r\n <<a title=\"Guidance on how to interpret the value by comparison to a normal or recommended range.\" class=\"dict\" href=\"observation-definitions.html#Observation.referenceRange\"><b>referenceRange</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Provides guide for interpretation --></span>\r\n <<a title=\"The value of the low bound of the reference range. If this is omitted, the low bound of the reference range is assumed to be meaningless. E.g. <2.3.\" class=\"dict\" href=\"observation-definitions.html#Observation.referenceRange.low\"><b>low</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-3: Must have at least a low or a high (and no comparators)\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">Low Range, if relevant</span><span style=\"color: Gray\"> --></span></low>\r\n <<a title=\"The value of the high bound of the reference range. If this is omitted, the high bound of the reference range is assumed to be meaningless. E.g. >5.\" class=\"dict\" href=\"observation-definitions.html#Observation.referenceRange.high\"><b>high</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-3: Must have at least a low or a high (and no comparators)\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">High Range, if relevant</span><span style=\"color: Gray\"> --></span></high>\r\n <<a title=\"Code for the meaning of the reference range.\" class=\"dict\" href=\"observation-definitions.html#Observation.referenceRange.meaning\"><b>meaning</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-referencerange-meaning.html\">Indicates the meaning/use of this range of this range</a></span><span style=\"color: Gray\"> --></span></meaning>\r\n <<a title=\"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.\" class=\"dict\" href=\"observation-definitions.html#Observation.referenceRange.age\"><b>age</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Range\">Range</a></span> <span style=\"color: navy\">Applicable age range, if relevant</span><span style=\"color: Gray\"> --></span></age>\r\n </referenceRange>\r\n <<a title=\"Related observations - either components, or previous observations, or statements of derivation.\" class=\"dict\" href=\"observation-definitions.html#Observation.related\"><b>related</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Observations related to this observation --></span>\r\n <<a title=\"A code specifying the kind of relationship that exists with the target observation.\" class=\"dict\" href=\"observation-definitions.html#Observation.related.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"observation-relationshiptypes.html\">has-component | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A reference to the observation that is related to this observation.\" class=\"dict\" href=\"observation-definitions.html#Observation.related.target\"><b>target</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"observation.html#Observation\">Observation</a>)</span> <span style=\"color: navy\">Observation that is related to this one</span><span style=\"color: Gray\"> --></span></target>\r\n </related>\r\n</Observation>\r\n</pre></div>"
},
"name": "observation",
"publisher": "FHIR Project",
"description": "Basic Profile. Measurements and simple assertions made about a patient, device or other subject.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage Observations are a central element in healthcare, used to support diagnosis, monitor progress, determine baselines and patterns and even capture demographic characteristics. Most observations are simple name/value pair assertions with some metadata, but some observations group other observations together logically, or even are multi-component observations. Note that the resources DiagnosticReport and DeviceObservationReport provide a clinical or workflow context for a set of observations. Expected uses for the Observation resource include: \r\n\r\n* Vital signs: temperature, blood pressure, respiration rate\r\n* Laboratory Data and other Diagnostic Measures\r\n* Measurements emitted by Devices\r\n* Clinical assessments such as APGAR\r\n* Personal characteristics: height, weight, eye-color\r\n* Diagnoses (Note: trackable conditions, allergies, adverse reactions and more complex structures are handled elsewhere)\r\n* Social history: tobacco use, family supports, cognitive status\r\n* Core characteristics: pregnancy status, death assertion",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "Observation",
"publish": true,
"element": [
{
"path": "Observation",
"definition": {
"short": "Measurements and simple assertions",
"formal": "Measurements and simple assertions made about a patient, device or other subject.",
"comments": "Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as Lab reports, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"constraint": [
{
"key": "2",
"name": "reference range for quantity",
"severity": "error",
"human": "Can only have normal range if value is a quantity",
"xpath": "exists(f:valueQuantity) or not(exists(f:normalRange))"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=EVN]"
},
{
"identity": "v2",
"map": "OBX"
}
]
}
},
{
"path": "Observation.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Observation.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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. In order to make the use of extensions safe and manageable, there is a strict 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Observation.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Observation.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "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.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Observation.name",
"definition": {
"short": "Type of observation (code / type)",
"formal": "Describes what was observed. Sometimes this is called the observation \"code\".",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ObservationType",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/observation-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": "code"
},
{
"identity": "v2",
"map": "OBX-3-observation identifier"
}
]
}
},
{
"path": "Observation.value[x]",
"definition": {
"short": "Actual result",
"formal": "The information determined as a result of making the observation, if the information has a simple value.",
"comments": "Normally, an observation will have either a value or a set of related observations. A few observations (e.g. apgar store) may have both a value and related observations (for apgar, the observations from which the measure is derived). If a value is present, the datatype for this element should be determined by Observation.name. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.name defines a coded value. The element, Observation.value[x], has a variable name depending on the type as follows: valueQuantity, valueCodeableConcept, valueRatio, valueChoice, valuePeriod, valueSampleData, or valueString (The name format is \"'value' + the type name\" with a capital on the first letter of the type).",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
},
{
"code": "CodeableConcept"
},
{
"code": "Attachment"
},
{
"code": "Ratio"
},
{
"code": "Period"
},
{
"code": "SampledData"
},
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "value"
},
{
"identity": "v2",
"map": "OBX.2, OBX.5, OBX.6"
}
]
}
},
{
"path": "Observation.interpretation",
"definition": {
"short": "High, low, normal, etc.",
"formal": "The assessment made based on the result of the observation.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ObservationInterpretation",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/observation-interpretation"
}
},
"mapping": [
{
"identity": "rim",
"map": "interpretationCode"
},
{
"identity": "v2",
"map": "OBX-8-interpretation codes"
}
]
}
},
{
"path": "Observation.comments",
"definition": {
"short": "Comments about result",
"formal": "May include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "subjectOf.observationEvent[code=\"annotation\"].value"
},
{
"identity": "v2",
"map": "NTE.3 (partner NTE to OBX, or sometimes another (child?) OBX)"
}
]
}
},
{
"path": "Observation.applies[x]",
"definition": {
"short": "Physiologically Relevant time/time-period for observation",
"formal": "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.",
"comments": "At least a date should be present unless this observation is a historical report.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "effectiveTime"
},
{
"identity": "v2",
"map": "OBX-14-date/time of the observation, and/or OBX-19 after v2.4 (depends on who observation made)"
}
]
}
},
{
"path": "Observation.issued",
"definition": {
"short": "Date/Time this was made available",
"formal": "Date/Time this was made available.",
"comments": "Updated when the result is updated.",
"min": 0,
"max": "1",
"type": [
{
"code": "instant"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=AUT].time"
},
{
"identity": "v2",
"map": "OBR.22 (or MSH.7), or perhaps OBX-19 (depends on who observation made)"
}
]
}
},
{
"path": "Observation.status",
"definition": {
"short": "registered | preliminary | final | amended +",
"formal": "The status of the result value.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ObservationStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/observation-status"
}
},
"mapping": [
{
"identity": "rim",
"map": "status\n\nAmended & Final are differentiated by whether it is the subject of a ControlAct event with a type of \"revise\""
},
{
"identity": "v2",
"map": "OBX-11-observation result status"
}
]
}
},
{
"path": "Observation.reliability",
"definition": {
"short": "ok | ongoing | early | questionable | calibrating | error +",
"formal": "An estimate of the degree to which quality issues have impacted on the value reported.",
"comments": "Note that in most contexts, unreliable results are not recorded, deleted, or otherwise excluded, but it's not always possible to exclude them from the record. Interpreters of a result, whether human or machine, SHALL always either be aware of the status, or prevented from using the observation without being unaware that the reliability is not \"ok\".",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ObservationReliability",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/observation-reliability"
}
},
"mapping": [
{
"identity": "rim",
"map": "uncertaintyCode"
},
{
"identity": "v2",
"map": "Maybe OBX.8/OBX.9"
}
]
}
},
{
"path": "Observation.bodySite",
"definition": {
"short": "Observed body part",
"formal": "Indicates where on the subject's body the observation was made.",
"comments": "Only used if not implicit in code found in Observation.name.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "BodySite",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/body-site"
}
},
"mapping": [
{
"identity": "rim",
"map": "targetSiteCode"
},
{
"identity": "v2",
"map": "OBX-20-observation site"
}
]
}
},
{
"path": "Observation.method",
"definition": {
"short": "How it was done",
"formal": "Indicates the mechanism used to perform the observation.",
"comments": "Only used if not implicit in code for Observation.name.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ObservationMethod",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/observation-methods"
}
},
"mapping": [
{
"identity": "rim",
"map": "methodCode"
},
{
"identity": "v2",
"map": "OBX-17-observation method"
}
]
}
},
{
"path": "Observation.identifier",
"definition": {
"short": "Unique Id for this particular observation",
"formal": "A unique identifier for the simple observation.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "id"
},
{
"identity": "v2",
"map": "OBX.21"
}
]
}
},
{
"path": "Observation.subject",
"definition": {
"short": "Who and/or what this is about",
"formal": "The thing the observation is being made about.",
"comments": "The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Group"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Location"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=SBJ]"
},
{
"identity": "v2",
"map": "PID-3-patient ID list"
}
]
}
},
{
"path": "Observation.specimen",
"definition": {
"short": "Specimen used for this observation",
"formal": "The specimen that was used when this observation was made.",
"comments": "Observations are not made on specimens themselves; they are made on a subject, but usually by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources are often used in contexts that track the specimen explicity (e.g. Diagnostic Report).",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Specimen"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=SPC].specimen"
}
]
}
},
{
"path": "Observation.performer",
"definition": {
"short": "Who did the observation",
"formal": "Who was responsible for asserting the observed value as \"true\".",
"comments": "This would only be \"Device\" if the device is responsible for the measurement, not to capture the device used by a human to make the measurement. (The latter could be captured as an extension.).",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=PRF]"
},
{
"identity": "v2",
"map": "OBX.15 / (Practitioner) OBX-16-responsible observer, PRT-5-participation person:PRT-4-participation='RO' / \n(Device) OBX-18-equipment instance identifier , PRT-10-participation device:PRT-4-participation='EQUIP' / (Organization) OBX-23-performing organization name, PRT-8-participation organization:PRT-4-participation='PO'"
}
]
}
},
{
"path": "Observation.referenceRange",
"definition": {
"short": "Provides guide for interpretation",
"formal": "Guidance on how to interpret the value by comparison to a normal or recommended range.",
"comments": "Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g. specific to the patient's age, gender, weight and other factors), but this may not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "3",
"name": "reference range",
"severity": "error",
"human": "Must have at least a low or a high (and no comparators)",
"xpath": "(exists(f:low) or exists(f:high)) and not(exists(f:low/f:comparator)) and not(exists(f:high/f:comparator))"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]"
}
]
}
},
{
"path": "Observation.referenceRange.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Observation.referenceRange.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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. In order to make the use of extensions safe and manageable, there is a strict 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Observation.referenceRange.low",
"definition": {
"short": "Low Range, if relevant",
"formal": "The value of the low bound of the reference range. If this is omitted, the low bound of the reference range is assumed to be meaningless. E.g. <2.3.",
"comments": "Do not use the comparator for < or >.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "value:IVL_PQ.low"
},
{
"identity": "v2",
"map": "OBX-7-references range"
}
]
}
},
{
"path": "Observation.referenceRange.high",
"definition": {
"short": "High Range, if relevant",
"formal": "The value of the high bound of the reference range. If this is omitted, the high bound of the reference range is assumed to be meaningless. E.g. >5.",
"comments": "Do not use the comparator for < or >.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "value:IVL_PQ.high"
},
{
"identity": "v2",
"map": "OBX-7-references range"
}
]
}
},
{
"path": "Observation.referenceRange.meaning",
"definition": {
"short": "Indicates the meaning/use of this range of this range",
"formal": "Code for the meaning of the reference range.",
"comments": "This SHOULD be populated if there is more than one range.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ObservationRangeMeaning",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/referencerange-meaning"
}
},
"mapping": [
{
"identity": "rim",
"map": "interpretationCode"
},
{
"identity": "v2",
"map": "OBX-10-nature of abnormal test?"
}
]
}
},
{
"path": "Observation.referenceRange.age",
"definition": {
"short": "Applicable age range, if relevant",
"formal": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "Range"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value"
}
]
}
},
{
"path": "Observation.related",
"definition": {
"short": "Observations related to this observation",
"formal": "Related observations - either components, or previous observations, or statements of derivation.",
"comments": "Normally, an observation will have either a value or a set of related observations. A few observations (e.g. apgar store) may have both a value and related observations (for apgar, the observations from which the measure is derived).",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "outBoundRelationship"
},
{
"identity": "v2",
"map": "Relationships established by OBX-4 usage"
}
]
}
},
{
"path": "Observation.related.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Observation.related.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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. In order to make the use of extensions safe and manageable, there is a strict 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Observation.related.type",
"definition": {
"short": "has-component | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by",
"formal": "A code specifying the kind of relationship that exists with the target observation.",
"comments": "A relationship type SHOULD be provided. If the relationship type is \"COMP\" (composed), then the observation should not be displayed/interpreted in the absence of the related observations.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "ObservationRelationshipType",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/observation-relationshiptypes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".typeCode"
},
{
"identity": "v2",
"map": "N/A"
}
]
}
},
{
"path": "Observation.related.target",
"definition": {
"short": "Observation that is related to this one",
"formal": "A reference to the observation that is related to this observation.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Observation"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".targetObservation"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "date",
"type": "date",
"documentation": "Obtained date/time. If the obtained element is a period, a date that falls in the period",
"xpath": "f:Observation/f:applies[x]"
},
{
"name": "name",
"type": "token",
"documentation": "The name of the observation type",
"xpath": "f:Observation/f:name"
},
{
"name": "name-value-[x]",
"type": "composite",
"documentation": "Both name and one of the value parameters"
},
{
"name": "performer",
"type": "reference",
"documentation": "Who and/or what performed the observation",
"xpath": "f:Observation/f:performer"
},
{
"name": "related",
"type": "composite",
"documentation": "Related Observations - search on related-type and related-target together"
},
{
"name": "related-target",
"type": "reference",
"documentation": "Observation that is related to this one",
"xpath": "f:Observation/f:related/f:target"
},
{
"name": "related-type",
"type": "token",
"documentation": "has-component | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by",
"xpath": "f:Observation/f:related/f:type"
},
{
"name": "reliability",
"type": "token",
"documentation": "The reliability of the observation",
"xpath": "f:Observation/f:reliability"
},
{
"name": "specimen",
"type": "reference",
"documentation": "Specimen used for this observation",
"xpath": "f:Observation/f:specimen"
},
{
"name": "status",
"type": "token",
"documentation": "The status of the observation",
"xpath": "f:Observation/f:status"
},
{
"name": "subject",
"type": "reference",
"documentation": "The subject that the observation is about",
"xpath": "f:Observation/f:subject"
},
{
"name": "value-concept",
"type": "token",
"documentation": "The value of the observation, if the value is a CodeableConcept",
"xpath": "f:Observation/f:value[x]"
},
{
"name": "value-date",
"type": "date",
"documentation": "The value of the observation, if the value is a Period",
"xpath": "f:Observation/f:value[x]"
},
{
"name": "value-quantity",
"type": "quantity",
"documentation": "The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"xpath": "f:Observation/f:value[x]"
},
{
"name": "value-string",
"type": "string",
"documentation": "The value of the observation, if the value is a string, and also searches in CodeableConcept.text",
"xpath": "f:Observation/f:value[x]"
}
]
}
]
}
© HL7.org 2011+. FHIR DSTU (v0.0.82.2943) generated on Tue, Sep 30, 2014 18:10+1000.
Links:
What's a DSTU? |
Version History |
|
Propose a change