. 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
<Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="observation-definitions.html#Observation" title="Measurements and simple assertions made about a patient, device or other subject."><b>Observation</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="observation-definitions.html#Observation.name" title="Describes what was observed. Sometimes this is called the observation "code"."><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 href="valueset-observation-codes.html" style="color: navy">Type of observation (code / type)</a></span><span style="color: Gray"> --></span></name> <<a class="dict" href="observation-definitions.html#Observation.value_x_" title="The information determined as a result of making the observation, if the information has a simple value."><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>| <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]> <<a class="dict" href="observation-definitions.html#Observation.interpretation" title="The assessment made based on the result of the observation."><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 href="valueset-observation-interpretation.html" style="color: navy">High, low, normal, etc.</a></span><span style="color: Gray"> --></span></interpretation> <<a class="dict" href="observation-definitions.html#Observation.comments" 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."><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> <<a class="dict" href="observation-definitions.html#Observation.applies_x_" 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."><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"> Physiologically Relevant time/time-period for observation</span><span style="color: Gray"> --></span></applies[x]> <<a class="dict" href="observation-definitions.html#Observation.issued" title="Date/Time this was made available."><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> <<a class="dict" href="observation-definitions.html#Observation.status" title="The status of the result value (this element modifies the meaning of other elements)"><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 href="observation-status.html" style="color: navy">registered | preliminary | final | amended +</a></span><span style="color: Gray"> --></span> <<a class="dict" href="observation-definitions.html#Observation.reliability" title="An estimate of the degree to which quality issues have impacted on the value reported (this element modifies the meaning of other elements)"><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 href="observation-reliability.html" style="color: navy">ok | ongoing | early | questionable | calibrating | error +</a></span><span style="color: Gray"> --></span> <<a class="dict" href="observation-definitions.html#Observation.bodySite" title="Indicates where on the subject's body the observation was made."><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 href="valueset-body-site.html" style="color: navy">Observed body part</a></span><span style="color: Gray"> --></span></bodySite> <<a class="dict" href="observation-definitions.html#Observation.method" title="Indicates the mechanism used to perform the observation."><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 href="valueset-observation-methods.html" style="color: navy">How it was done</a></span><span style="color: Gray"> --></span></method> <<a class="dict" href="observation-definitions.html#Observation.identifier" title="A unique identifier for the simple observation."><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> <<a class="dict" href="observation-definitions.html#Observation.subject" title="The thing the observation is being made about."><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> <<a class="dict" href="observation-definitions.html#Observation.specimen" title="The specimen that was used when this observation was made."><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> <<a class="dict" href="observation-definitions.html#Observation.performer" title="Who was responsible for asserting the observed value as "true"."><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> <<a class="dict" href="observation-definitions.html#Observation.referenceRange" title="Guidance on how to interpret the value by comparison to a normal or recommended range."><b>referenceRange</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Provides guide for interpretation --></span> <<a class="dict" href="observation-definitions.html#Observation.referenceRange.low" 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."><b>low</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-3: Must have at least a low or a high (and no comparators)"><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> <<a class="dict" href="observation-definitions.html#Observation.referenceRange.high" 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."><b>high</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-3: Must have at least a low or a high (and no comparators)"><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> <<a class="dict" href="observation-definitions.html#Observation.referenceRange.meaning" title="Code for the meaning of the reference range."><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 href="valueset-referencerange-meaning.html" style="color: navy">Indicates the meaning/use of this range of this range</a></span><span style="color: Gray"> --></span></meaning> <<a class="dict" href="observation-definitions.html#Observation.referenceRange.age" 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."><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> </referenceRange> <<a class="dict" href="observation-definitions.html#Observation.related" title="Related observations - either components, or previous observations, or statements of derivation."><b>related</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Observations related to this observation --></span> <<a class="dict" href="observation-definitions.html#Observation.related.type" title="A code specifying the kind of relationship that exists with the target observation."><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 href="observation-relationshiptypes.html" style="color: navy">has-component | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by</a></span><span style="color: Gray"> --></span> <<a class="dict" href="observation-definitions.html#Observation.related.target" title="A reference to the observation that is related to this observation."><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> </related> </Observation> </pre></div> </text> <name value="observation"/> <publisher value="FHIR Project"/> <description value="Basic Profile. Measurements and simple assertions made about a patient, device or other subject."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="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: * Vital signs: temperature, blood pressure, respiration rate * Laboratory Data and other Diagnostic Measures * Measurements emitted by Devices * Clinical assessments such as APGAR * Personal characteristics: height, weight, eye-color * Diagnoses (Note: trackable conditions, allergies, adverse reactions and more complex structures are handled elsewhere) * Social history: tobacco use, family supports, cognitive status * Core characteristics: pregnancy status, death assertion"/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <structure> <type value="Observation"/> <publish value="true"/> <element> <path value="Observation"/> <definition> <short value="Measurements and simple assertions"/> <formal value="Measurements and simple assertions made about a patient, device or other subject."/> <comments value="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 value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <constraint> <key value="2"/> <name value="reference range for quantity"/> <severity value="error"/> <human value="Can only have normal range if value is a quantity"/> <xpath value="exists(f:valueQuantity) or not(exists(f:normalRange))"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Observation[classCode=OBS, moodCode=EVN]"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX"/> </mapping> </definition> </element> <element> <path value="Observation.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="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 value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Observation.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="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 value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Observation.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Observation.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Observation.name"/> <definition> <short value="Type of observation (code / type)"/> <formal value="Describes what was observed. Sometimes this is called the observation "code"."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="ObservationType"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/observation-codes"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="code"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-3-observation identifier"/> </mapping> </definition> </element> <element> <path value="Observation.value[x]"/> <definition> <short value="Actual result"/> <formal value="The information determined as a result of making the observation, if the information has a simple value."/> <comments value="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.val ue[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 value="0"/> <max value="1"/> <type> <code value="Quantity"/> </type> <type> <code value="CodeableConcept"/> </type> <type> <code value="Attachment"/> </type> <type> <code value="Ratio"/> </type> <type> <code value="Period"/> </type> <type> <code value="SampledData"/> </type> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="value"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX.2, OBX.5, OBX.6"/> </mapping> </definition> </element> <element> <path value="Observation.interpretation"/> <definition> <short value="High, low, normal, etc."/> <formal value="The assessment made based on the result of the observation."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="ObservationInterpretation"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/observation-interpretation"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="interpretationCode"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-8-interpretation codes"/> </mapping> </definition> </element> <element> <path value="Observation.comments"/> <definition> <short value="Comments about result"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="subjectOf.observationEvent[code="annotation"].value"/> </mapping> <mapping> <identity value="v2"/> <map value="NTE.3 (partner NTE to OBX, or sometimes another (child?) OBX)"/> </mapping> </definition> </element> <element> <path value="Observation.applies[x]"/> <definition> <short value="Physiologically Relevant time/time-period for observation"/> <formal value="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 value="At least a date should be present unless this observation is a historical report."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <type> <code value="Period"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="effectiveTime"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-14-date/time of the observation, and/or OBX-19 after v2.4 (depends on who observation made)"/> </mapping> </definition> </element> <element> <path value="Observation.issued"/> <definition> <short value="Date/Time this was made available"/> <formal value="Date/Time this was made available."/> <comments value="Updated when the result is updated."/> <min value="0"/> <max value="1"/> <type> <code value="instant"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="participation[typeCode=AUT].time"/> </mapping> <mapping> <identity value="v2"/> <map value="OBR.22 (or MSH.7), or perhaps OBX-19 (depends on who observation made)"/> </mapping> </definition> </element> <element> <path value="Observation.status"/> <definition> <short value="registered | preliminary | final | amended +"/> <formal value="The status of the result value."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="ObservationStatus"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/observation-status"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="status Amended & Final are differentiated by whether it is the subject of a ControlAct event with a type of "revise""/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-11-observation result status"/> </mapping> </definition> </element> <element> <path value="Observation.reliability"/> <definition> <short value="ok | ongoing | early | questionable | calibrating | error +"/> <formal value="An estimate of the degree to which quality issues have impacted on the value reported."/> <comments value="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 value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="ObservationReliability"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/observation-reliability"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="uncertaintyCode"/> </mapping> <mapping> <identity value="v2"/> <map value="Maybe OBX.8/OBX.9"/> </mapping> </definition> </element> <element> <path value="Observation.bodySite"/> <definition> <short value="Observed body part"/> <formal value="Indicates where on the subject's body the observation was made."/> <comments value="Only used if not implicit in code found in Observation.name."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="BodySite"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/body-site"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="targetSiteCode"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-20-observation site"/> </mapping> </definition> </element> <element> <path value="Observation.method"/> <definition> <short value="How it was done"/> <formal value="Indicates the mechanism used to perform the observation."/> <comments value="Only used if not implicit in code for Observation.name."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="ObservationMethod"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/observation-methods"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="methodCode"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-17-observation method"/> </mapping> </definition> </element> <element> <path value="Observation.identifier"/> <definition> <short value="Unique Id for this particular observation"/> <formal value="A unique identifier for the simple observation."/> <min value="0"/> <max value="1"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="id"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX.21"/> </mapping> </definition> </element> <element> <path value="Observation.subject"/> <definition> <short value="Who and/or what this is about"/> <formal value="The thing the observation is being made about."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Group"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Device"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Location"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="participation[typeCode=SBJ]"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-3-patient ID list"/> </mapping> </definition> </element> <element> <path value="Observation.specimen"/> <definition> <short value="Specimen used for this observation"/> <formal value="The specimen that was used when this observation was made."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Specimen"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="participation[typeCode=SPC].specimen"/> </mapping> </definition> </element> <element> <path value="Observation.performer"/> <definition> <short value="Who did the observation"/> <formal value="Who was responsible for asserting the observed value as "true"."/> <comments value="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 value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Device"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Organization"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="participation[typeCode=PRF]"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX.15 / (Practitioner) OBX-16-responsible observer, PRT-5-participation person:PRT-4-participatio n='RO' / (Device) OBX-18-equipment instance identifier , PRT-10-participation device:PRT-4-particip ation='EQUIP' / (Organization) OBX-23-performing organization name, PRT-8-participation organization:PRT-4-participation='PO'"/> </mapping> </definition> </element> <element> <path value="Observation.referenceRange"/> <definition> <short value="Provides guide for interpretation"/> <formal value="Guidance on how to interpret the value by comparison to a normal or recommended range."/> <comments value="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 value="0"/> <max value="*"/> <constraint> <key value="3"/> <name value="reference range"/> <severity value="error"/> <human value="Must have at least a low or a high (and no comparators)"/> <xpath value="(exists(f:low) or exists(f:high)) and not(exists(f:low/f:comparator)) and not(exists(f:high/f:compar ator))"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]"/> </mapping> </definition> </element> <element> <path value="Observation.referenceRange.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="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 value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Observation.referenceRange.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="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 value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Observation.referenceRange.low"/> <definition> <short value="Low Range, if relevant"/> <formal value="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 value="Do not use the comparator for < or >."/> <min value="0"/> <max value="1"/> <type> <code value="Quantity"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="value:IVL_PQ.low"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-7-references range"/> </mapping> </definition> </element> <element> <path value="Observation.referenceRange.high"/> <definition> <short value="High Range, if relevant"/> <formal value="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 value="Do not use the comparator for < or >."/> <min value="0"/> <max value="1"/> <type> <code value="Quantity"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="value:IVL_PQ.high"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-7-references range"/> </mapping> </definition> </element> <element> <path value="Observation.referenceRange.meaning"/> <definition> <short value="Indicates the meaning/use of this range of this range"/> <formal value="Code for the meaning of the reference range."/> <comments value="This SHOULD be populated if there is more than one range."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="ObservationRangeMeaning"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/referencerange-meaning"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="interpretationCode"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-10-nature of abnormal test?"/> </mapping> </definition> </element> <element> <path value="Observation.referenceRange.age"/> <definition> <short value="Applicable age range, if relevant"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="Range"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="outboundRelationship[typeCode=PRCN].targetObservationCriterion[code="age"].value"/> </mapping> </definition> </element> <element> <path value="Observation.related"/> <definition> <short value="Observations related to this observation"/> <formal value="Related observations - either components, or previous observations, or statements of derivation."/> <comments value="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 value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="outBoundRelationship"/> </mapping> <mapping> <identity value="v2"/> <map value="Relationships established by OBX-4 usage"/> </mapping> </definition> </element> <element> <path value="Observation.related.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="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 value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Observation.related.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="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 value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Observation.related.type"/> <definition> <short value="has-component | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by"/> <formal value="A code specifying the kind of relationship that exists with the target observation."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="ObservationRelationshipType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/observation-relationshiptypes"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".typeCode"/> </mapping> <mapping> <identity value="v2"/> <map value="N/A"/> </mapping> </definition> </element> <element> <path value="Observation.related.target"/> <definition> <short value="Observation that is related to this one"/> <formal value="A reference to the observation that is related to this observation."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Observation"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".targetObservation"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="date"/> <type value="date"/> <documentation value="Obtained date/time. If the obtained element is a period, a date that falls in the period"/> <xpath value="f:Observation/f:applies[x]"/> </searchParam> <searchParam> <name value="name"/> <type value="token"/> <documentation value="The name of the observation type"/> <xpath value="f:Observation/f:name"/> </searchParam> <searchParam> <name value="name-value-[x]"/> <type value="composite"/> <documentation value="Both name and one of the value parameters"/> </searchParam> <searchParam> <name value="performer"/> <type value="reference"/> <documentation value="Who and/or what performed the observation"/> <xpath value="f:Observation/f:performer"/> </searchParam> <searchParam> <name value="related"/> <type value="composite"/> <documentation value="Related Observations - search on related-type and related-target together"/> </searchParam> <searchParam> <name value="related-target"/> <type value="reference"/> <documentation value="Observation that is related to this one"/> <xpath value="f:Observation/f:related/f:target"/> </searchParam> <searchParam> <name value="related-type"/> <type value="token"/> <documentation value="has-component | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by"/> <xpath value="f:Observation/f:related/f:type"/> </searchParam> <searchParam> <name value="reliability"/> <type value="token"/> <documentation value="The reliability of the observation"/> <xpath value="f:Observation/f:reliability"/> </searchParam> <searchParam> <name value="specimen"/> <type value="reference"/> <documentation value="Specimen used for this observation"/> <xpath value="f:Observation/f:specimen"/> </searchParam> <searchParam> <name value="status"/> <type value="token"/> <documentation value="The status of the observation"/> <xpath value="f:Observation/f:status"/> </searchParam> <searchParam> <name value="subject"/> <type value="reference"/> <documentation value="The subject that the observation is about"/> <xpath value="f:Observation/f:subject"/> </searchParam> <searchParam> <name value="value-concept"/> <type value="token"/> <documentation value="The value of the observation, if the value is a CodeableConcept"/> <xpath value="f:Observation/f:value[x]"/> </searchParam> <searchParam> <name value="value-date"/> <type value="date"/> <documentation value="The value of the observation, if the value is a Period"/> <xpath value="f:Observation/f:value[x]"/> </searchParam> <searchParam> <name value="value-quantity"/> <type value="quantity"/> <documentation value="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 value="f:Observation/f:value[x]"/> </searchParam> <searchParam> <name value="value-string"/> <type value="string"/> <documentation value="The value of the observation, if the value is a string, and also searches in CodeableConcept.text"/> <xpath value="f:Observation/f:value[x]"/> </searchParam> </structure> </Profile>
© 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