{ "resourceType": "StructureDefinition", "id": "spark65", "meta": { "versionId": "spark65", "lastUpdated": "2015-10-02T11:54:41.671+00:00" }, "text": { "status": "generated", "div": "
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\"ObservationIDomainResourceMeasurements and simple assertions\r\n
SHALL only be present if Observation.value[x] is not present
Component code SHALL not be same as observation code
\".\"\".\"\".\"identifier0..*IdentifierUnique Id for this particular observation
\".\"\".\"\".\"status?! Σ1..1coderegistered | preliminary | final | amended +\r\n
ObservationStatus (\r\n Required)\r\n
\".\"\".\"\".\"category0..1CodeableConceptClassification of type of observation\r\n
Observation Category Codes (\r\n Example)\r\n
\".\"\".\"\".\"codeΣ1..1CodeableConceptType of observation (code / type)\r\n
LOINC Codes (\r\n Example)\r\n
\".\"\".\"\".\"subjectΣ0..1Reference(\r\n Patient | \r\n Group | \r\n Device | \r\n Location)\r\n Who and/or what this is about
\".\"\".\"\".\"encounter0..1Reference(\r\n Encounter)\r\n Healthcare event during which this observation is made
\".\"\".\"\".\"effective[x]Σ0..1Clinically relevant time/time-period for observation
\".\"\".\"\".\"\".\"effectiveDateTimedateTime
\".\"\".\"\".\"\".\"effectivePeriodPeriod
\".\"\".\"\".\"issuedΣ0..1instantDate/Time this was made available
\".\"\".\"\".\"performerΣ0..*Reference(\r\n Practitioner | \r\n Organization | \r\n Patient | \r\n RelatedPerson)\r\n Who is responsible for the observation
\".\"\".\"\".\"value[x]Σ0..1Actual result
\".\"\".\"\".\"\".\"valueQuantityQuantity
\".\"\".\"\".\"\".\"valueCodeableConceptCodeableConcept
\".\"\".\"\".\"\".\"valueStringstring
\".\"\".\"\".\"\".\"valueRangeRange
\".\"\".\"\".\"\".\"valueRatioRatio
\".\"\".\"\".\"\".\"valueSampledDataSampledData
\".\"\".\"\".\"\".\"valueAttachmentAttachment
\".\"\".\"\".\"\".\"valueTimetime
\".\"\".\"\".\"\".\"valueDateTimedateTime
\".\"\".\"\".\"\".\"valuePeriodPeriod
\".\"\".\"\".\"dataAbsentReasonI0..1CodeableConceptWhy the result is missing\r\n
Observation Value Absent Reason (\r\n Extensible)\r\n
\".\"\".\"\".\"interpretation0..1CodeableConceptHigh, low, normal, etc.\r\n
Observation Interpretation Codes (\r\n Extensible)\r\n
\".\"\".\"\".\"comments0..1stringComments about result
\".\"\".\"\".\"bodySite0..1CodeableConceptObserved body part\r\n
SNOMED CT Body Structures (\r\n Example)\r\n
\".\"\".\"\".\"method0..1CodeableConceptHow it was done\r\n
Observation Methods (\r\n Example)\r\n
\".\"\".\"\".\"specimen0..1Reference(\r\n Specimen)\r\n Specimen used for this observation
\".\"\".\"\".\"device0..1Reference(\r\n Device | \r\n DeviceMetric)\r\n (Measurement) Device
\".\"\".\"\".\"referenceRangeI0..*BackboneElementProvides guide for interpretation\r\n
Must have at least a low or a high or text
\".\"\".\"\".\"\".\"lowI0..1SimpleQuantityLow Range, if relevant
\".\"\".\"\".\"\".\"highI0..1SimpleQuantityHigh Range, if relevant
\".\"\".\"\".\"\".\"meaning0..1CodeableConceptIndicates the meaning/use of this range of this range\r\n
Observation Reference Range Meaning Codes (\r\n Example)\r\n
\".\"\".\"\".\"\".\"age0..1RangeApplicable age range, if relevant
\".\"\".\"\".\"\".\"text0..1stringText based reference range in an observation
\".\"\".\"\".\"relatedΣ0..*BackboneElementResource related to this observation
\".\"\".\"\".\"\".\"type0..1codehas-member | derived-from | sequel-to | replaces | qualified-by | interfered-by\r\n
ObservationRelationshipType (\r\n Required)\r\n
\".\"\".\"\".\"\".\"target1..1Reference(\r\n Observation | \r\n QuestionnaireResponse)\r\n Resource that is related to this one
\".\"\".\"\".\"componentΣ0..*BackboneElementComponent results
\".\"\".\"\".\"\".\"codeΣ I1..1CodeableConceptType of component observation (code / type)\r\n
LOINC Codes (\r\n Example)\r\n
\".\"\".\"\".\"\".\"value[x]Σ0..1Actual component result
\".\"\".\"\".\"\".\"\".\"valueQuantityQuantity
\".\"\".\"\".\"\".\"\".\"valueCodeableConceptCodeableConcept
\".\"\".\"\".\"\".\"\".\"valueStringstring
\".\"\".\"\".\"\".\"\".\"valueRangeRange
\".\"\".\"\".\"\".\"\".\"valueRatioRatio
\".\"\".\"\".\"\".\"\".\"valueSampledDataSampledData
\".\"\".\"\".\"\".\"\".\"valueAttachmentAttachment
\".\"\".\"\".\"\".\"\".\"valueTimetime
\".\"\".\"\".\"\".\"\".\"valueDateTimedateTime
\".\"\".\"\".\"\".\"\".\"valuePeriodPeriod
\".\"\".\"\".\"\".\"dataAbsentReasonI0..1CodeableConceptWhy the component result is missing\r\n
Observation Value Absent Reason (\r\n Extensible)\r\n
\".\"\".\"\".\"\".\"referenceRange0..*see \r\n referenceRangeProvides guide for interpretation of component result

\"doco\" Documentation for this format\r\n
" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 4 } ], "url": "http://hl7.org/fhir/StructureDefinition/Observation", "name": "Observation", "status": "draft", "publisher": "Health Level Seven International (Orders and Observations)", "contact": [ { "telecom": [ { "system": "other", "value": "http://hl7.org/fhir" } ] }, { "telecom": [ { "system": "other", "value": "http://www.hl7.org/Special/committees/orders/index.cfm" } ] } ], "date": "2015-09-22T03:47:23+00:00", "description": "Base StructureDefinition for Observation Resource", "requirements": "Observations are a key aspect of healthcare. This resource is used to capture those that do not require more sophisticated mechanisms.", "fhirVersion": "1.0.1", "mapping": [ { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM" }, { "identity": "w5", "uri": "http://hl7.org/fhir/w5", "name": "W5 Mapping" } ], "kind": "resource", "abstract": false, "base": "http://hl7.org/fhir/StructureDefinition/DomainResource", "snapshot": { "element": [ { "path": "Observation", "short": "Measurements and simple assertions", "definition": "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.", "alias": [ "Vital Signs", "Measurement", "Results", "Tests" ], "min": 0, "max": "*", "type": [ { "code": "DomainResource" } ], "constraint": [ { "key": "obs-6", "severity": "error", "human": "SHALL only be present if Observation.value[x] is not present", "xpath": "not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))" }, { "key": "obs-7", "severity": "error", "human": "Component code SHALL not be same as observation code", "xpath": "not(exists(f:component/f:code)) or count(for $coding in f:code/f:coding return parent::*/f:component/f:code/f:coding[f:code/@value=$coding/f:code/@value and f:system/@value=$coding/f:system/@value])=0" } ], "mapping": [ { "identity": "v2", "map": "OBX" }, { "identity": "rim", "map": "Observation[classCode=OBS, moodCode=EVN]" }, { "identity": "w5", "map": "clinical.diagnostics" } ] }, { "path": "Observation.id", "short": "Logical id of this artifact", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.", "min": 0, "max": "1", "type": [ { "code": "id" } ], "isSummary": true }, { "path": "Observation.meta", "short": "Metadata about the resource", "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.", "min": 0, "max": "1", "type": [ { "code": "Meta" } ], "isSummary": true }, { "path": "Observation.implicitRules", "short": "A set of rules under which this content was created", "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.", "comments": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isModifier": true, "isSummary": true }, { "path": "Observation.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "comments": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).", "min": 0, "max": "1", "type": [ { "code": "code" } ], "binding": { "strength": "required", "description": "A human language.", "valueSetUri": "http://tools.ietf.org/html/bcp47" } }, { "path": "Observation.text", "short": "Text summary of the resource, for human interpretation", "definition": "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.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "type": [ { "code": "Narrative" } ], "condition": [ "dom-1" ], "mapping": [ { "identity": "rim", "map": "Act.text?" } ] }, { "path": "Observation.contained", "short": "Contained, inline Resources", "definition": "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.", "alias": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "*", "type": [ { "code": "Resource" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Observation.extension", "short": "Additional Content defined by implementations", "definition": "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 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.", "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 level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Observation.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "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 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.", "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 level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Observation.identifier", "short": "Unique Id for this particular observation", "definition": "A unique identifier for the simple observation instance.", "requirements": "Allows observations to be distinguished and referenced.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "mapping": [ { "identity": "v2", "map": "OBX.21" }, { "identity": "rim", "map": "id" }, { "identity": "w5", "map": "id" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint", "valueString": "default: final" } ], "path": "Observation.status", "short": "registered | preliminary | final | amended +", "definition": "The status of the result value.", "requirements": "Need to track the status of individual results. Some results are finalized before the whole report is finalized.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "strength": "required", "description": "Codes providing the status of an observation.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/observation-status" } }, "mapping": [ { "identity": "v2", "map": "OBX-11" }, { "identity": "rim", "map": "status Amended & Final are differentiated by whether it is the subject of a ControlAct event with a type of \"revise\"" }, { "identity": "w5", "map": "status" } ] }, { "path": "Observation.category", "short": "Classification of type of observation", "definition": "A code that classifies the general type of observation being made. This is used for searching, sorting and display purposes.", "comments": "The level of granularity is defined by the category concepts in the value set. More fine-grained filtering can be performed using the metadata and/or terminology hierarchy in Observation.code.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "example", "description": "Codes for high level observation categories .", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/observation-category" } }, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" }, { "identity": "w5", "map": "class" } ] }, { "path": "Observation.code", "short": "Type of observation (code / type)", "definition": "Describes what was observed. Sometimes this is called the observation \"name\".", "requirements": "Knowing what kind of observation is being made is essential to understanding the observation.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "strength": "example", "description": "Codes identifying names of simple observations.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/observation-codes" } }, "mapping": [ { "identity": "v2", "map": "OBX-3" }, { "identity": "rim", "map": "code" }, { "identity": "w5", "map": "what" } ] }, { "path": "Observation.subject", "short": "Who and/or what this is about", "definition": "The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject.", "comments": "One would expect this element to be a cardinality of 1..1. 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. If the target of the observation is different than the subject, the general extension [observation-focal-subject](extension-observation-focal-subject.html). may be used. However, the distinction between the patient's own value for an observation versus that of the fetus, or the donor or blood product unit, etc., are often specified in the observation code.", "requirements": "Observations have no value if you don't know who or what they're about.", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Patient" ] }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Group" ] }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Device" ] }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Location" ] } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "PID-3" }, { "identity": "rim", "map": "participation[typeCode=SBJ]" }, { "identity": "w5", "map": "who.focus" } ] }, { "path": "Observation.encounter", "short": "Healthcare event during which this observation is made", "definition": "The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.", "requirements": "For some observations it may be important to know the link between an observation and a particular encounter.", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Encounter" ] } ], "mapping": [ { "identity": "v2", "map": "PV1" }, { "identity": "rim", "map": "inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]" }, { "identity": "w5", "map": "context" } ] }, { "path": "Observation.effective[x]", "short": "Clinically relevant time/time-period for observation", "definition": "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.", "requirements": "Knowing when an observation was deemed true is important to its relevance as well as determining trends.", "min": 0, "max": "1", "type": [ { "code": "dateTime" }, { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "OBX-14, and/or OBX-19 after v2.4 (depends on who observation made)" }, { "identity": "rim", "map": "effectiveTime" }, { "identity": "w5", "map": "when.done" } ] }, { "path": "Observation.issued", "short": "Date/Time this was made available", "definition": "The date and time this observation was made available to providers, typically after the results have been reviewed and verified.", "comments": "Updated when the result is updated.", "min": 0, "max": "1", "type": [ { "code": "instant" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "OBR.22 (or MSH.7), or perhaps OBX-19 (depends on who observation made)" }, { "identity": "rim", "map": "participation[typeCode=AUT].time" }, { "identity": "w5", "map": "when.recorded" } ] }, { "path": "Observation.performer", "short": "Who is responsible for the observation", "definition": "Who was responsible for asserting the observed value as \"true\".", "requirements": "May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.", "min": 0, "max": "*", "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner" ] }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Patient" ] }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ] } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "OBX.15 / (Practitioner) OBX-16, PRT-5:PRT-4='RO' / (Device) OBX-18 , PRT-10:PRT-4='EQUIP' / (Organization) OBX-23, PRT-8:PRT-4='PO'" }, { "identity": "rim", "map": "participation[typeCode=PRF]" }, { "identity": "w5", "map": "who.actor" } ] }, { "path": "Observation.value[x]", "short": "Actual result", "definition": "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 score) may have both a value and related observations (for an Apgar score, the observations from which the measure is derived). If a value is present, the datatype for this element should be determined by Observation.code. This element has a variable name depending on the type as follows: valueQuantity, valueCodeableConcept, valueString, valueRange, valueRatio, valueSampledData, valueAttachment, valueTime, valueDateTime, or valuePeriod. (The name format is \"'value' + the type name\" with a capital on the first letter of the type). If the data element is usually coded or if the type associated with the Observation.value defines a coded value, use CodeableConcept instead of string datatype even if the value is uncoded text. A value set is bound to the ValueCodeableConcept element. For boolean values use valueCodeableConcept and select codes from [HL7 Version 2 Table 0136](v2/0136/index.html). These \"yes/no\" concepts can be mapped to the display name \"true/false\" or other mutually exclusive terms that may be needed. For further discussion and examples see the [notes section](observation.html#4.20.4) below.", "requirements": "An observation exists to have a value, though it may not if it is in error, or it represents a group of observations.", "min": 0, "max": "1", "type": [ { "code": "Quantity" }, { "code": "CodeableConcept" }, { "code": "string" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "SampledData" }, { "code": "Attachment" }, { "code": "time" }, { "code": "dateTime" }, { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "OBX.2, OBX.5, OBX.6" }, { "identity": "rim", "map": "value" } ] }, { "path": "Observation.dataAbsentReason", "short": "Why the result is missing", "definition": "Provides a reason why the expected value in the element Observation.value[x] is missing.", "comments": "Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"specimen unsatisfactory\". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values.", "requirements": "For many results it is necessary to handle exceptional values in measurements.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "condition": [ "obs-6" ], "binding": { "strength": "extensible", "description": "Codes specifying why the result (Observation.value[x]) is missing.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/observation-valueabsentreason" } }, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "value.nullFlavor" } ] }, { "path": "Observation.interpretation", "short": "High, low, normal, etc.", "definition": "The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag.", "requirements": "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", "alias": [ "Abnormal Flag" ], "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "extensible", "description": "Codes identifying interpretations of observations.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/observation-interpretation" } }, "mapping": [ { "identity": "v2", "map": "OBX-8" }, { "identity": "rim", "map": "interpretationCode" } ] }, { "path": "Observation.comments", "short": "Comments about result", "definition": "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.", "requirements": "Need to be able to provide free text additional information.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "v2", "map": "NTE.3 (partner NTE to OBX, or sometimes another (child?) OBX)" }, { "identity": "rim", "map": "subjectOf.observationEvent[code=\"annotation\"].value" } ] }, { "path": "Observation.bodySite", "short": "Observed body part", "definition": "Indicates the site on the subject's body where the observation was made (i.e. the target site).", "comments": "Only used if not implicit in code found in Observation.code. If the use case requires BodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension[ body-site-instance](extension-body-site-instance.html).", "requirements": "Knowing where the observation is made is important for tracking if multiple sites are possible.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "example", "description": "Codes describing anatomical locations. May include laterality.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/body-site" } }, "mapping": [ { "identity": "v2", "map": "OBX-20" }, { "identity": "rim", "map": "targetSiteCode" } ] }, { "path": "Observation.method", "short": "How it was done", "definition": "Indicates the mechanism used to perform the observation.", "comments": "Only used if not implicit in code for Observation.code.", "requirements": "In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "example", "description": "Methods for simple observations.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/observation-methods" } }, "mapping": [ { "identity": "v2", "map": "OBX-17" }, { "identity": "rim", "map": "methodCode" } ] }, { "path": "Observation.specimen", "short": "Specimen used for this observation", "definition": "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 may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Specimen" ] } ], "mapping": [ { "identity": "v2", "map": "SPM segment" }, { "identity": "rim", "map": "participation[typeCode=SPC].specimen" } ] }, { "path": "Observation.device", "short": "(Measurement) Device", "definition": "The device used to generate the observation data.", "comments": "An extension should be used if further typing of the device is needed. Devices used to support obtaining an observation can be represented using either extension or through the Observation.related element.", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Device" ] }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/DeviceMetric" ] } ], "mapping": [ { "identity": "v2", "map": "OBX-17 / PRT -10" }, { "identity": "rim", "map": "participation[typeCode=DEV]" } ] }, { "path": "Observation.referenceRange", "name": "referenceRange", "short": "Provides guide for interpretation", "definition": "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.", "requirements": "Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "obs-3", "severity": "error", "human": "Must have at least a low or a high or text", "xpath": "(exists(f:low) or exists(f:high)or exists(f:text))" } ], "mapping": [ { "identity": "v2", "map": "OBX.7" }, { "identity": "rim", "map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" } ] }, { "path": "Observation.referenceRange.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Observation.referenceRange.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.", "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 level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Observation.referenceRange.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "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 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 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.", "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 level of simplicity for everyone.", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Observation.referenceRange.low", "short": "Low Range, if relevant", "definition": "The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).", "min": 0, "max": "1", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ], "condition": [ "obs-3" ], "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:IVL_PQ.low" } ] }, { "path": "Observation.referenceRange.high", "short": "High Range, if relevant", "definition": "The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).", "min": 0, "max": "1", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ], "condition": [ "obs-3" ], "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:IVL_PQ.high" } ] }, { "path": "Observation.referenceRange.meaning", "short": "Indicates the meaning/use of this range of this range", "definition": "Code for the meaning of the reference range.", "comments": "This SHOULD be populated if there is more than one range.", "requirements": "Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, or perhaps what state this reference range applies to (i.e. age, hormonal cycles, etc.).", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "example", "description": "Code for the meaning of a reference range.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/referencerange-meaning" } }, "mapping": [ { "identity": "v2", "map": "OBX-10?" }, { "identity": "rim", "map": "interpretationCode" } ] }, { "path": "Observation.referenceRange.age", "short": "Applicable age range, if relevant", "definition": "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.", "requirements": "Some analytes vary greatly over age.", "min": 0, "max": "1", "type": [ { "code": "Range" } ], "mapping": [ { "identity": "rim", "map": "outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value" } ] }, { "path": "Observation.referenceRange.text", "short": "Text based reference range in an observation", "definition": "Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of \"Negative\" or a list or table of 'normals'.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:ST" } ] }, { "path": "Observation.related", "short": "Resource related to this observation", "definition": "A reference to another resource (usually another Observation but could also be a QuestionnaireAnswer) whose relationship is defined by the relationship type code.", "comments": "For a discussion on the ways Observations can assembled in groups together see [Notes below](observation.html#4.20.4).", "requirements": "Normally, an observation will have either a value or a set of related observations. A few observations (e.g. Apgar score) may have both a value and a set of related observations or sometimes QuestionnaireResponse from which the measure is derived.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "Relationships established by OBX-4 usage" }, { "identity": "rim", "map": "outBoundRelationship" } ] }, { "path": "Observation.related.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Observation.related.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.", "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 level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Observation.related.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "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 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 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.", "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 level of simplicity for everyone.", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Observation.related.type", "short": "has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by", "definition": "A code specifying the kind of relationship that exists with the target resource.", "comments": "\"derived-from\" is only logical choice when referencing QuestionnaireAnswer resource.", "requirements": "A relationship type SHOULD be provided.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "binding": { "strength": "required", "description": "Codes specifying how two observations are related.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/observation-relationshiptypes" } }, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": ".typeCode" } ] }, { "path": "Observation.related.target", "short": "Resource that is related to this one", "definition": "A reference to the observation or [[[QuestionnaireResponse]]] resource that is related to this observation.", "min": 1, "max": "1", "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Observation" ] }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse" ] } ], "mapping": [ { "identity": "rim", "map": ".targetObservation" } ] }, { "path": "Observation.component", "short": "Component results", "definition": "Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.", "comments": "For a discussion on the ways Observations can assembled in groups together see [Notes below](observation.html#4.20.4).", "requirements": "Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "containment by OBX-4?" }, { "identity": "rim", "map": "outBoundRelationship[typeCode=COMP]" } ] }, { "path": "Observation.component.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Observation.component.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.", "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 level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Observation.component.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "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 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 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.", "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 level of simplicity for everyone.", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Observation.component.code", "short": "Type of component observation (code / type)", "definition": "Describes what was observed. Sometimes this is called the observation \"code\".", "requirements": "Knowing what kind of observation is being made is essential to understanding the observation.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "condition": [ "obs-7" ], "isSummary": true, "binding": { "strength": "example", "description": "Codes identifying names of simple observations.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/observation-codes" } }, "mapping": [ { "identity": "v2", "map": "OBX-3" }, { "identity": "rim", "map": "code" }, { "identity": "w5", "map": "what" } ] }, { "path": "Observation.component.value[x]", "short": "Actual component result", "definition": "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 score) may have both a value and related observations (for an Apgar score, the observations from which the measure is derived). If a value is present, the datatype for this element should be determined by Observation.code. 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.code defines a coded value. For boolean values use valueCodeableConcept and select codes from (These \"yes/no\" concepts can be mapped to the display name \"true/false\" or other mutually exclusive terms that may be needed\"). 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).", "requirements": "An observation exists to have a value, though it may not if it is in error, or it represents a group of observations.", "min": 0, "max": "1", "type": [ { "code": "Quantity" }, { "code": "CodeableConcept" }, { "code": "string" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "SampledData" }, { "code": "Attachment" }, { "code": "time" }, { "code": "dateTime" }, { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "OBX.2, OBX.5, OBX.6" }, { "identity": "rim", "map": "value" } ] }, { "path": "Observation.component.dataAbsentReason", "short": "Why the component result is missing", "definition": "Provides a reason why the expected value in the element Observation.value[x] is missing.", "comments": "\"Null\" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"test not done\". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values.", "requirements": "For many results it is necessary to handle exceptional values in measurements.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "condition": [ "obs-6" ], "binding": { "strength": "extensible", "description": "Codes specifying why the result (Observation.value[x]) is missing.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/observation-valueabsentreason" } }, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "value.nullFlavor" } ] }, { "path": "Observation.component.referenceRange", "short": "Provides guide for interpretation of component result", "definition": "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.", "requirements": "Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.", "min": 0, "max": "*", "nameReference": "referenceRange", "mapping": [ { "identity": "v2", "map": "OBX.7" }, { "identity": "rim", "map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" } ] } ] }, "differential": { "element": [ { "path": "Observation", "short": "Measurements and simple assertions", "definition": "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.", "alias": [ "Vital Signs", "Measurement", "Results", "Tests" ], "min": 0, "max": "*", "type": [ { "code": "DomainResource" } ], "constraint": [ { "key": "obs-6", "severity": "error", "human": "SHALL only be present if Observation.value[x] is not present", "xpath": "not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))" }, { "key": "obs-7", "severity": "error", "human": "Component code SHALL not be same as observation code", "xpath": "not(exists(f:component/f:code)) or count(for $coding in f:code/f:coding return parent::*/f:component/f:code/f:coding[f:code/@value=$coding/f:code/@value and f:system/@value=$coding/f:system/@value])=0" } ], "mapping": [ { "identity": "v2", "map": "OBX" }, { "identity": "rim", "map": "Observation[classCode=OBS, moodCode=EVN]" }, { "identity": "w5", "map": "clinical.diagnostics" } ] }, { "path": "Observation.identifier", "short": "Unique Id for this particular observation", "definition": "A unique identifier for the simple observation instance.", "requirements": "Allows observations to be distinguished and referenced.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "mapping": [ { "identity": "v2", "map": "OBX.21" }, { "identity": "rim", "map": "id" }, { "identity": "w5", "map": "id" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint", "valueString": "default: final" } ], "path": "Observation.status", "short": "registered | preliminary | final | amended +", "definition": "The status of the result value.", "requirements": "Need to track the status of individual results. Some results are finalized before the whole report is finalized.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "strength": "required", "description": "Codes providing the status of an observation.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/observation-status" } }, "mapping": [ { "identity": "v2", "map": "OBX-11" }, { "identity": "rim", "map": "status Amended & Final are differentiated by whether it is the subject of a ControlAct event with a type of \"revise\"" }, { "identity": "w5", "map": "status" } ] }, { "path": "Observation.category", "short": "Classification of type of observation", "definition": "A code that classifies the general type of observation being made. This is used for searching, sorting and display purposes.", "comments": "The level of granularity is defined by the category concepts in the value set. More fine-grained filtering can be performed using the metadata and/or terminology hierarchy in Observation.code.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "example", "description": "Codes for high level observation categories .", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/observation-category" } }, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" }, { "identity": "w5", "map": "class" } ] }, { "path": "Observation.code", "short": "Type of observation (code / type)", "definition": "Describes what was observed. Sometimes this is called the observation \"name\".", "requirements": "Knowing what kind of observation is being made is essential to understanding the observation.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "strength": "example", "description": "Codes identifying names of simple observations.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/observation-codes" } }, "mapping": [ { "identity": "v2", "map": "OBX-3" }, { "identity": "rim", "map": "code" }, { "identity": "w5", "map": "what" } ] }, { "path": "Observation.subject", "short": "Who and/or what this is about", "definition": "The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject.", "comments": "One would expect this element to be a cardinality of 1..1. 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. If the target of the observation is different than the subject, the general extension [observation-focal-subject](extension-observation-focal-subject.html). may be used. However, the distinction between the patient's own value for an observation versus that of the fetus, or the donor or blood product unit, etc., are often specified in the observation code.", "requirements": "Observations have no value if you don't know who or what they're about.", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Patient" ] }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Group" ] }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Device" ] }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Location" ] } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "PID-3" }, { "identity": "rim", "map": "participation[typeCode=SBJ]" }, { "identity": "w5", "map": "who.focus" } ] }, { "path": "Observation.encounter", "short": "Healthcare event during which this observation is made", "definition": "The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.", "requirements": "For some observations it may be important to know the link between an observation and a particular encounter.", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Encounter" ] } ], "mapping": [ { "identity": "v2", "map": "PV1" }, { "identity": "rim", "map": "inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]" }, { "identity": "w5", "map": "context" } ] }, { "path": "Observation.effective[x]", "short": "Clinically relevant time/time-period for observation", "definition": "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.", "requirements": "Knowing when an observation was deemed true is important to its relevance as well as determining trends.", "min": 0, "max": "1", "type": [ { "code": "dateTime" }, { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "OBX-14, and/or OBX-19 after v2.4 (depends on who observation made)" }, { "identity": "rim", "map": "effectiveTime" }, { "identity": "w5", "map": "when.done" } ] }, { "path": "Observation.issued", "short": "Date/Time this was made available", "definition": "The date and time this observation was made available to providers, typically after the results have been reviewed and verified.", "comments": "Updated when the result is updated.", "min": 0, "max": "1", "type": [ { "code": "instant" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "OBR.22 (or MSH.7), or perhaps OBX-19 (depends on who observation made)" }, { "identity": "rim", "map": "participation[typeCode=AUT].time" }, { "identity": "w5", "map": "when.recorded" } ] }, { "path": "Observation.performer", "short": "Who is responsible for the observation", "definition": "Who was responsible for asserting the observed value as \"true\".", "requirements": "May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.", "min": 0, "max": "*", "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner" ] }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Patient" ] }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ] } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "OBX.15 / (Practitioner) OBX-16, PRT-5:PRT-4='RO' / (Device) OBX-18 , PRT-10:PRT-4='EQUIP' / (Organization) OBX-23, PRT-8:PRT-4='PO'" }, { "identity": "rim", "map": "participation[typeCode=PRF]" }, { "identity": "w5", "map": "who.actor" } ] }, { "path": "Observation.value[x]", "short": "Actual result", "definition": "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 score) may have both a value and related observations (for an Apgar score, the observations from which the measure is derived). If a value is present, the datatype for this element should be determined by Observation.code. This element has a variable name depending on the type as follows: valueQuantity, valueCodeableConcept, valueString, valueRange, valueRatio, valueSampledData, valueAttachment, valueTime, valueDateTime, or valuePeriod. (The name format is \"'value' + the type name\" with a capital on the first letter of the type). If the data element is usually coded or if the type associated with the Observation.value defines a coded value, use CodeableConcept instead of string datatype even if the value is uncoded text. A value set is bound to the ValueCodeableConcept element. For boolean values use valueCodeableConcept and select codes from [HL7 Version 2 Table 0136](v2/0136/index.html). These \"yes/no\" concepts can be mapped to the display name \"true/false\" or other mutually exclusive terms that may be needed. For further discussion and examples see the [notes section](observation.html#4.20.4) below.", "requirements": "An observation exists to have a value, though it may not if it is in error, or it represents a group of observations.", "min": 0, "max": "1", "type": [ { "code": "Quantity" }, { "code": "CodeableConcept" }, { "code": "string" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "SampledData" }, { "code": "Attachment" }, { "code": "time" }, { "code": "dateTime" }, { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "OBX.2, OBX.5, OBX.6" }, { "identity": "rim", "map": "value" } ] }, { "path": "Observation.dataAbsentReason", "short": "Why the result is missing", "definition": "Provides a reason why the expected value in the element Observation.value[x] is missing.", "comments": "Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"specimen unsatisfactory\". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values.", "requirements": "For many results it is necessary to handle exceptional values in measurements.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "condition": [ "obs-6" ], "binding": { "strength": "extensible", "description": "Codes specifying why the result (Observation.value[x]) is missing.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/observation-valueabsentreason" } }, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "value.nullFlavor" } ] }, { "path": "Observation.interpretation", "short": "High, low, normal, etc.", "definition": "The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag.", "requirements": "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", "alias": [ "Abnormal Flag" ], "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "extensible", "description": "Codes identifying interpretations of observations.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/observation-interpretation" } }, "mapping": [ { "identity": "v2", "map": "OBX-8" }, { "identity": "rim", "map": "interpretationCode" } ] }, { "path": "Observation.comments", "short": "Comments about result", "definition": "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.", "requirements": "Need to be able to provide free text additional information.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "v2", "map": "NTE.3 (partner NTE to OBX, or sometimes another (child?) OBX)" }, { "identity": "rim", "map": "subjectOf.observationEvent[code=\"annotation\"].value" } ] }, { "path": "Observation.bodySite", "short": "Observed body part", "definition": "Indicates the site on the subject's body where the observation was made (i.e. the target site).", "comments": "Only used if not implicit in code found in Observation.code. If the use case requires BodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension[ body-site-instance](extension-body-site-instance.html).", "requirements": "Knowing where the observation is made is important for tracking if multiple sites are possible.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "example", "description": "Codes describing anatomical locations. May include laterality.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/body-site" } }, "mapping": [ { "identity": "v2", "map": "OBX-20" }, { "identity": "rim", "map": "targetSiteCode" } ] }, { "path": "Observation.method", "short": "How it was done", "definition": "Indicates the mechanism used to perform the observation.", "comments": "Only used if not implicit in code for Observation.code.", "requirements": "In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "example", "description": "Methods for simple observations.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/observation-methods" } }, "mapping": [ { "identity": "v2", "map": "OBX-17" }, { "identity": "rim", "map": "methodCode" } ] }, { "path": "Observation.specimen", "short": "Specimen used for this observation", "definition": "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 may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Specimen" ] } ], "mapping": [ { "identity": "v2", "map": "SPM segment" }, { "identity": "rim", "map": "participation[typeCode=SPC].specimen" } ] }, { "path": "Observation.device", "short": "(Measurement) Device", "definition": "The device used to generate the observation data.", "comments": "An extension should be used if further typing of the device is needed. Devices used to support obtaining an observation can be represented using either extension or through the Observation.related element.", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Device" ] }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/DeviceMetric" ] } ], "mapping": [ { "identity": "v2", "map": "OBX-17 / PRT -10" }, { "identity": "rim", "map": "participation[typeCode=DEV]" } ] }, { "path": "Observation.referenceRange", "name": "referenceRange", "short": "Provides guide for interpretation", "definition": "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.", "requirements": "Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.", "min": 0, "max": "*", "constraint": [ { "key": "obs-3", "severity": "error", "human": "Must have at least a low or a high or text", "xpath": "(exists(f:low) or exists(f:high)or exists(f:text))" } ], "mapping": [ { "identity": "v2", "map": "OBX.7" }, { "identity": "rim", "map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" } ] }, { "path": "Observation.referenceRange.low", "short": "Low Range, if relevant", "definition": "The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).", "min": 0, "max": "1", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ], "condition": [ "obs-3" ], "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:IVL_PQ.low" } ] }, { "path": "Observation.referenceRange.high", "short": "High Range, if relevant", "definition": "The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).", "min": 0, "max": "1", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ], "condition": [ "obs-3" ], "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:IVL_PQ.high" } ] }, { "path": "Observation.referenceRange.meaning", "short": "Indicates the meaning/use of this range of this range", "definition": "Code for the meaning of the reference range.", "comments": "This SHOULD be populated if there is more than one range.", "requirements": "Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, or perhaps what state this reference range applies to (i.e. age, hormonal cycles, etc.).", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "example", "description": "Code for the meaning of a reference range.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/referencerange-meaning" } }, "mapping": [ { "identity": "v2", "map": "OBX-10?" }, { "identity": "rim", "map": "interpretationCode" } ] }, { "path": "Observation.referenceRange.age", "short": "Applicable age range, if relevant", "definition": "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.", "requirements": "Some analytes vary greatly over age.", "min": 0, "max": "1", "type": [ { "code": "Range" } ], "mapping": [ { "identity": "rim", "map": "outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value" } ] }, { "path": "Observation.referenceRange.text", "short": "Text based reference range in an observation", "definition": "Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of \"Negative\" or a list or table of 'normals'.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:ST" } ] }, { "path": "Observation.related", "short": "Resource related to this observation", "definition": "A reference to another resource (usually another Observation but could also be a QuestionnaireAnswer) whose relationship is defined by the relationship type code.", "comments": "For a discussion on the ways Observations can assembled in groups together see [Notes below](observation.html#4.20.4).", "requirements": "Normally, an observation will have either a value or a set of related observations. A few observations (e.g. Apgar score) may have both a value and a set of related observations or sometimes QuestionnaireResponse from which the measure is derived.", "min": 0, "max": "*", "isSummary": true, "mapping": [ { "identity": "v2", "map": "Relationships established by OBX-4 usage" }, { "identity": "rim", "map": "outBoundRelationship" } ] }, { "path": "Observation.related.type", "short": "has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by", "definition": "A code specifying the kind of relationship that exists with the target resource.", "comments": "\"derived-from\" is only logical choice when referencing QuestionnaireAnswer resource.", "requirements": "A relationship type SHOULD be provided.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "binding": { "strength": "required", "description": "Codes specifying how two observations are related.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/observation-relationshiptypes" } }, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": ".typeCode" } ] }, { "path": "Observation.related.target", "short": "Resource that is related to this one", "definition": "A reference to the observation or [[[QuestionnaireResponse]]] resource that is related to this observation.", "min": 1, "max": "1", "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Observation" ] }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse" ] } ], "mapping": [ { "identity": "rim", "map": ".targetObservation" } ] }, { "path": "Observation.component", "short": "Component results", "definition": "Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.", "comments": "For a discussion on the ways Observations can assembled in groups together see [Notes below](observation.html#4.20.4).", "requirements": "Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation.", "min": 0, "max": "*", "isSummary": true, "mapping": [ { "identity": "v2", "map": "containment by OBX-4?" }, { "identity": "rim", "map": "outBoundRelationship[typeCode=COMP]" } ] }, { "path": "Observation.component.code", "short": "Type of component observation (code / type)", "definition": "Describes what was observed. Sometimes this is called the observation \"code\".", "requirements": "Knowing what kind of observation is being made is essential to understanding the observation.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "condition": [ "obs-7" ], "isSummary": true, "binding": { "strength": "example", "description": "Codes identifying names of simple observations.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/observation-codes" } }, "mapping": [ { "identity": "v2", "map": "OBX-3" }, { "identity": "rim", "map": "code" }, { "identity": "w5", "map": "what" } ] }, { "path": "Observation.component.value[x]", "short": "Actual component result", "definition": "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 score) may have both a value and related observations (for an Apgar score, the observations from which the measure is derived). If a value is present, the datatype for this element should be determined by Observation.code. 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.code defines a coded value. For boolean values use valueCodeableConcept and select codes from (These \"yes/no\" concepts can be mapped to the display name \"true/false\" or other mutually exclusive terms that may be needed\"). 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).", "requirements": "An observation exists to have a value, though it may not if it is in error, or it represents a group of observations.", "min": 0, "max": "1", "type": [ { "code": "Quantity" }, { "code": "CodeableConcept" }, { "code": "string" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "SampledData" }, { "code": "Attachment" }, { "code": "time" }, { "code": "dateTime" }, { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "OBX.2, OBX.5, OBX.6" }, { "identity": "rim", "map": "value" } ] }, { "path": "Observation.component.dataAbsentReason", "short": "Why the component result is missing", "definition": "Provides a reason why the expected value in the element Observation.value[x] is missing.", "comments": "\"Null\" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"test not done\". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values.", "requirements": "For many results it is necessary to handle exceptional values in measurements.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "condition": [ "obs-6" ], "binding": { "strength": "extensible", "description": "Codes specifying why the result (Observation.value[x]) is missing.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/observation-valueabsentreason" } }, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "value.nullFlavor" } ] }, { "path": "Observation.component.referenceRange", "short": "Provides guide for interpretation of component result", "definition": "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.", "requirements": "Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.", "min": 0, "max": "*", "nameReference": "referenceRange", "mapping": [ { "identity": "v2", "map": "OBX.7" }, { "identity": "rim", "map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" } ] } ] } }