Observation
Property | Value |
---|---|
Publisher | |
Name | Observation |
URL | http://hl7.org/fhir/StructureDefinition/Observation |
Status | active |
Description | |
Abstract | false |
Structure
Path | Cardinality | Type | Description |
---|---|---|---|
Observation | 0..* | Observation | Measurements and simple assertions made about a patient, device or other subject. |
Observation.id | 0..1 | http://hl7.org/fhirpath/System.String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Observation.meta | 0..1 | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Observation.implicitRules | 0..1 | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Observation.language | 0..1 | code | The base language in which the resource is written. |
Observation.text | 0..1 | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Observation.contained | 0..* | Resource | 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. |
Observation.extension | 0..* | Extension | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Observation.modifierExtension | 0..* | Extension | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Observation.identifier | 0..* | Identifier | A unique identifier assigned to this observation. |
Observation.basedOn | 0..* | Reference | A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed. |
Observation.partOf | 0..* | Reference | A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. |
Observation.status | 1..1 | code | The status of the result value. |
Observation.category | 0..* | CodeableConcept | A code that classifies the general type of observation being made. |
Observation.code | 1..1 | CodeableConcept | Describes what was observed. Sometimes this is called the observation "name". |
Observation.subject | 0..1 | Reference | The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation. |
Observation.focus | 0..* | Reference | The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. |
Observation.encounter | 0..1 | Reference | The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. |
Observation.effective[x] | 0..1 | dateTime | 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. |
Observation.issued | 0..1 | instant | The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. |
Observation.performer | 0..* | Reference | Who was responsible for asserting the observed value as "true". |
Observation.value[x] | 0..1 | Quantity | The information determined as a result of making the observation, if the information has a simple value. |
Observation.dataAbsentReason | 0..1 | CodeableConcept | Provides a reason why the expected value in the element Observation.value[x] is missing. |
Observation.interpretation | 0..* | CodeableConcept | A categorical assessment of an observation value. For example, high, low, normal. |
Observation.note | 0..* | Annotation | Comments about the observation or the results. |
Observation.bodySite | 0..1 | CodeableConcept | Indicates the site on the subject's body where the observation was made (i.e. the target site). |
Observation.method | 0..1 | CodeableConcept | Indicates the mechanism used to perform the observation. |
Observation.specimen | 0..1 | Reference | The specimen that was used when this observation was made. |
Observation.device | 0..1 | Reference | The device used to generate the observation data. |
Observation.referenceRange | 0..* | BackboneElement | Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. |
Observation.referenceRange.id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Observation.referenceRange.extension | 0..* | Extension | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Observation.referenceRange.modifierExtension | 0..* | Extension | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Observation.referenceRange.low | 0..1 | Quantity | 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). |
Observation.referenceRange.high | 0..1 | Quantity | 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). |
Observation.referenceRange.type | 0..1 | CodeableConcept | Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. |
Observation.referenceRange.appliesTo | 0..* | CodeableConcept | Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used. |
Observation.referenceRange.age | 0..1 | Range | 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. |
Observation.referenceRange.text | 0..1 | string | 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". |
Observation.hasMember | 0..* | Reference | This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group. |
Observation.derivedFrom | 0..* | Reference | The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. |
Observation.component | 0..* | BackboneElement | 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. |
Observation.component.id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Observation.component.extension | 0..* | Extension | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Observation.component.modifierExtension | 0..* | Extension | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Observation.component.code | 1..1 | CodeableConcept | Describes what was observed. Sometimes this is called the observation "code". |
Observation.component.value[x] | 0..1 | Quantity | The information determined as a result of making the observation, if the information has a simple value. |
Observation.component.dataAbsentReason | 0..1 | CodeableConcept | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Observation.component.interpretation | 0..* | CodeableConcept | A categorical assessment of an observation value. For example, high, low, normal. |
Observation.component.referenceRange | 0..* | Observation | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Search Parameters
Name | Type | Description | Expression |
---|---|---|---|
_text | string | Search on the narrative of the resource | |
_content | string | Search on the entire content of the resource | |
_id | token | Logical id of this artifact | Resource.id |
_lastUpdated | date | When the resource version last changed | Resource.meta.lastUpdated |
_profile | uri | Profiles this resource claims to conform to | Resource.meta.profile |
_query | token | A custom search profile that describes a specific defined query operation | |
_security | token | Security Labels applied to this resource | Resource.meta.security |
_source | uri | Identifies where the resource comes from | Resource.meta.source |
_tag | token | Tags applied to this resource | Resource.meta.tag |
code | token | Multiple Resources: * AllergyIntolerance: Code that identifies the allergy or intolerance* Condition: Code for the condition* DeviceRequest: Code for what is being requested/ordered* DiagnosticReport: The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result* FamilyMemberHistory: A search by a condition code* List: What the purpose of this list is* Medication: Returns medications for a specific code* MedicationAdministration: Return administrations of this medication code* MedicationDispense: Returns dispenses of this medicine code* MedicationRequest: Return prescriptions of this medication code* MedicationStatement: Return statements of this medication code* Observation: The code of the observation type* Procedure: A code to identify a procedure* ServiceRequest: What is being requested/ordered | AllergyIntolerance.code / AllergyIntolerance.reaction.substance / Condition.code / (DeviceRequest.code.ofType(CodeableConcept)) / DiagnosticReport.code / FamilyMemberHistory.condition.code / List.code / Medication.code / (MedicationAdministration.medication.ofType(CodeableConcept)) / (MedicationDispense.medication.ofType(CodeableConcept)) / (MedicationRequest.medication.ofType(CodeableConcept)) / (MedicationStatement.medication.ofType(CodeableConcept)) / Observation.code / Procedure.code / ServiceRequest.code |
date | date | Multiple Resources: * AllergyIntolerance: Date first version of the resource instance was recorded* CarePlan: Time period plan covers* CareTeam: Time period team covers* ClinicalImpression: When the assessment was documented* Composition: Composition editing time* Consent: When this Consent was created or indexed* DiagnosticReport: The clinically relevant time of the report* Encounter: A date within the period the Encounter lasted* EpisodeOfCare: The provided date search value falls within the episode of care's period* FamilyMemberHistory: When history was recorded or last updated* Flag: Time period when flag is active* Immunization: Vaccination (non)-Administration Date* List: When the list was prepared* Observation: Obtained date/time. If the obtained element is a period, a date that falls in the period* Procedure: When the procedure was performed* RiskAssessment: When was assessment made?* SupplyRequest: When the request was made | AllergyIntolerance.recordedDate / CarePlan.period / CareTeam.period / ClinicalImpression.date / Composition.date / Consent.dateTime / DiagnosticReport.effective / Encounter.period / EpisodeOfCare.period / FamilyMemberHistory.date / Flag.period / Immunization.occurrence / List.date / Observation.effective / Procedure.performed / (RiskAssessment.occurrence.ofType(dateTime)) / SupplyRequest.authoredOn |
identifier | token | Multiple Resources: * AllergyIntolerance: External ids for this item* CarePlan: External Ids for this plan* CareTeam: External Ids for this team* Composition: Version-independent identifier for the Composition* Condition: A unique identifier of the condition record* Consent: Identifier for this record (external references)* DetectedIssue: Unique id for the detected issue* DeviceRequest: Business identifier for request/order* DiagnosticReport: An identifier for the report* DocumentManifest: Unique Identifier for the set of documents* DocumentReference: Master Version Specific Identifier* Encounter: Identifier(s) by which this encounter is known* EpisodeOfCare: Business Identifier(s) relevant for this EpisodeOfCare* FamilyMemberHistory: A search by a record identifier* Goal: External Ids for this goal* ImagingStudy: Identifiers for the Study, such as DICOM Study Instance UID and Accession number* Immunization: Business identifier* List: Business identifier* MedicationAdministration: Return administrations with this external identifier* MedicationDispense: Returns dispenses with this external identifier* MedicationRequest: Return prescriptions with this external identifier* MedicationStatement: Return statements with this external identifier* NutritionOrder: Return nutrition orders with this external identifier* Observation: The unique id for a particular observation* Procedure: A unique identifier for a procedure* RiskAssessment: Unique identifier for the assessment* ServiceRequest: Identifiers assigned to this order* SupplyDelivery: External identifier* SupplyRequest: Business Identifier for SupplyRequest* VisionPrescription: Return prescriptions with this external identifier | AllergyIntolerance.identifier / CarePlan.identifier / CareTeam.identifier / Composition.identifier / Condition.identifier / Consent.identifier / DetectedIssue.identifier / DeviceRequest.identifier / DiagnosticReport.identifier / DocumentManifest.masterIdentifier / DocumentManifest.identifier / DocumentReference.masterIdentifier / DocumentReference.identifier / Encounter.identifier / EpisodeOfCare.identifier / FamilyMemberHistory.identifier / Goal.identifier / ImagingStudy.identifier / Immunization.identifier / List.identifier / MedicationAdministration.identifier / MedicationDispense.identifier / MedicationRequest.identifier / MedicationStatement.identifier / NutritionOrder.identifier / Observation.identifier / Procedure.identifier / RiskAssessment.identifier / ServiceRequest.identifier / SupplyDelivery.identifier / SupplyRequest.identifier / VisionPrescription.identifier |
patient | reference | Multiple Resources: * AllergyIntolerance: Who the sensitivity is for* CarePlan: Who the care plan is for* CareTeam: Who care team is for* ClinicalImpression: Patient or group assessed* Composition: Who and/or what the composition is about* Condition: Who has the condition?* Consent: Who the consent applies to* DetectedIssue: Associated patient* DeviceRequest: Individual the service is ordered for* DeviceUseStatement: Search by subject - a patient* DiagnosticReport: The subject of the report if a patient* DocumentManifest: The subject of the set of documents* DocumentReference: Who/what is the subject of the document* Encounter: The patient or group present at the encounter* EpisodeOfCare: The patient who is the focus of this episode of care* FamilyMemberHistory: The identity of a subject to list family member history items for* Flag: The identity of a subject to list flags for* Goal: Who this goal is intended for* ImagingStudy: Who the study is about* Immunization: The patient for the vaccination record* List: If all resources have the same subject* MedicationAdministration: The identity of a patient to list administrations for* MedicationDispense: The identity of a patient to list dispenses for* MedicationRequest: Returns prescriptions for a specific patient* MedicationStatement: Returns statements for a specific patient.* NutritionOrder: The identity of the person who requires the diet, formula or nutritional supplement* Observation: The subject that the observation is about (if patient)* Procedure: Search by subject - a patient* RiskAssessment: Who/what does assessment apply to?* ServiceRequest: Search by subject - a patient* SupplyDelivery: Patient for whom the item is supplied* VisionPrescription: The identity of a patient to list dispenses for | AllergyIntolerance.patient / CarePlan.subject.where(resolve() is Patient) / CareTeam.subject.where(resolve() is Patient) / ClinicalImpression.subject.where(resolve() is Patient) / Composition.subject.where(resolve() is Patient) / Condition.subject.where(resolve() is Patient) / Consent.patient / DetectedIssue.patient / DeviceRequest.subject.where(resolve() is Patient) / DeviceUseStatement.subject / DiagnosticReport.subject.where(resolve() is Patient) / DocumentManifest.subject.where(resolve() is Patient) / DocumentReference.subject.where(resolve() is Patient) / Encounter.subject.where(resolve() is Patient) / EpisodeOfCare.patient / FamilyMemberHistory.patient / Flag.subject.where(resolve() is Patient) / Goal.subject.where(resolve() is Patient) / ImagingStudy.subject.where(resolve() is Patient) / Immunization.patient / List.subject.where(resolve() is Patient) / MedicationAdministration.subject.where(resolve() is Patient) / MedicationDispense.subject.where(resolve() is Patient) / MedicationRequest.subject.where(resolve() is Patient) / MedicationStatement.subject.where(resolve() is Patient) / NutritionOrder.patient / Observation.subject.where(resolve() is Patient) / Procedure.subject.where(resolve() is Patient) / RiskAssessment.subject.where(resolve() is Patient) / ServiceRequest.subject.where(resolve() is Patient) / SupplyDelivery.patient / VisionPrescription.patient |
encounter | reference | Multiple Resources: * Composition: Context of the Composition* DeviceRequest: Encounter during which request was created* DiagnosticReport: The Encounter when the order was made* DocumentReference: Context of the document content* Flag: Alert relevant during encounter* List: Context in which list created* NutritionOrder: Return nutrition orders with this encounter identifier* Observation: Encounter related to the observation* Procedure: Encounter created as part of* RiskAssessment: Where was assessment performed?* ServiceRequest: An encounter in which this request is made* VisionPrescription: Return prescriptions with this encounter identifier | Composition.encounter / DeviceRequest.encounter / DiagnosticReport.encounter / DocumentReference.context.encounter / Flag.encounter / List.encounter / NutritionOrder.encounter / Observation.encounter / Procedure.encounter / RiskAssessment.encounter / ServiceRequest.encounter / VisionPrescription.encounter |
based-on | reference | Reference to the service request. | Observation.basedOn |
category | token | The classification of the type of observation | Observation.category |
combo-code | token | The code of the observation type or component type | Observation.code / Observation.component.code |
combo-data-absent-reason | token | The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing. | Observation.dataAbsentReason / Observation.component.dataAbsentReason |
combo-value-concept | token | The value or component value of the observation, if the value is a CodeableConcept | (Observation.value.ofType(CodeableConcept)) / (Observation.component.value.ofType(CodeableConcept)) |
combo-value-quantity | quantity | The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) | (Observation.value.ofType(Quantity)) / (Observation.value.ofType(SampledData)) / (Observation.component.value.ofType(Quantity)) / (Observation.component.value.ofType(SampledData)) |
component-code | token | The component code of the observation type | Observation.component.code |
component-data-absent-reason | token | The reason why the expected value in the element Observation.component.value[x] is missing. | Observation.component.dataAbsentReason |
component-value-concept | token | The value of the component observation, if the value is a CodeableConcept | (Observation.component.value.ofType(CodeableConcept)) |
component-value-quantity | quantity | The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) | (Observation.component.value.ofType(Quantity)) / (Observation.component.value.ofType(SampledData)) |
data-absent-reason | token | The reason why the expected value in the element Observation.value[x] is missing. | Observation.dataAbsentReason |
derived-from | reference | Related measurements the observation is made from | Observation.derivedFrom |
device | reference | The Device that generated the observation data. | Observation.device |
focus | reference | The focus of an observation when the focus is not the patient of record. | Observation.focus |
has-member | reference | Related resource that belongs to the Observation group | Observation.hasMember |
method | token | The method used for the observation | Observation.method |
part-of | reference | Part of referenced event | Observation.partOf |
performer | reference | Who performed the observation | Observation.performer |
specimen | reference | Specimen used for this observation | Observation.specimen |
status | token | The status of the observation | Observation.status |
subject | reference | The subject that the observation is about | Observation.subject |
value-concept | token | The value of the observation, if the value is a CodeableConcept | (Observation.value.ofType(CodeableConcept)) |
value-date | date | The value of the observation, if the value is a date or period of time | (Observation.value.ofType(dateTime)) / (Observation.value.ofType(Period)) |
value-quantity | quantity | 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) | (Observation.value.ofType(Quantity)) / (Observation.value.ofType(SampledData)) |
value-string | string | The value of the observation, if the value is a string, and also searches in CodeableConcept.text | (Observation.value.ofType(string)) / (Observation.value.ofType(CodeableConcept)).text |
code-value-concept | composite | Code and coded value parameter pair | Observation |
code-value-date | composite | Code and date/time value parameter pair | Observation |
code-value-quantity | composite | Code and quantity value parameter pair | Observation |
code-value-string | composite | Code and string value parameter pair | Observation |
combo-code-value-concept | composite | Code and coded value parameter pair, including in components | Observation / Observation.component |
combo-code-value-quantity | composite | Code and quantity value parameter pair, including in components | Observation / Observation.component |
component-code-value-concept | composite | Component code and component coded value parameter pair | Observation.component |
component-code-value-quantity | composite | Component code and component quantity value parameter pair | Observation.component |
_iguhealth-version-seq | number | The version sequence of the resource | Resource.meta.extension.where(url='https://iguhealth.app/version-sequence').value |
_iguhealth-author | reference | The author of the resource | Resource.meta.extension.where(url='https://iguhealth.app/author').value |