# Get FHIR r4 observation by ID
Endpoint: GET /site/{siteId}/fhir/observation/{id}
Version: 1.0
Security: bearer, bearer
## Path parameters:
- `id` (string, required)
ID of the Observation
- `siteId` (string, required)
Site identifier
## Response 200 fields (application/json):
- `resourceType` (any, required)
This is a Observation resource
Enum: "Observation"
- `id` (string)
Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.
Example: "example-id"
- `meta` (object)
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- `meta.id` (string)
An extension object type #string.
Example: "example-string"
- `meta.extension` (array)
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.
- `meta.versionId` (object)
An extension object type #id.
- `meta._versionId` (object)
An extension object type #Element.
- `meta.lastUpdated` (object)
An extension object type #instant.
- `meta._lastUpdated` (object)
An extension object type #Element.
- `meta.source` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `meta._source` (object)
An extension object type #Element.
- `meta.profile` (array)
A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].
Example: ["http://example.org/Profile"]
- `meta.security` (array)
Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
- `meta.tag` (array)
Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
- `implicitRules` (string)
String of characters used to identify a name or a resource
Example: "https://example.org/resource"
- `_implicitRules` (object)
Base definition for all elements in a resource.
- `language` (string)
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
Example: "sample-code"
- `_language` (object)
Base definition for all elements in a resource.
- `text` (object)
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
- `text.status` (any)
The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
Enum: "generated", "extensions", "additional", "empty"
- `text._status` (object)
An extension object type #Element.
- `text.div` (string, required)
An extension object type #xhtml.
Example: "
Example
"
- `contained` (array)
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.
- `extension` (array)
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.
- `extension.url` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `extension._url` (object)
An extension object type #Element.
- `extension.valueBase64Binary` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "U2FtcGxl"
- `extension._valueBase64Binary` (object)
An extension object type #Element.
- `extension.valueBoolean` (boolean)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: true
- `extension._valueBoolean` (object)
An extension object type #Element.
- `extension.valueCanonical` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "http://example.org/Profile"
- `extension._valueCanonical` (object)
An extension object type #Element.
- `extension.valueCode` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "sample-code"
- `extension._valueCode` (object)
An extension object type #Element.
- `extension.valueDate` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "2024-01-01"
- `extension._valueDate` (object)
An extension object type #Element.
- `extension.valueDateTime` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "2024-01-01T00:00:00Z"
- `extension._valueDateTime` (object)
An extension object type #Element.
- `extension.valueDecimal` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: 1.23
- `extension._valueDecimal` (object)
An extension object type #Element.
- `extension.valueId` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "example-id"
- `extension._valueId` (object)
An extension object type #Element.
- `extension.valueInstant` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "2024-01-01T00:00:00Z"
- `extension._valueInstant` (object)
An extension object type #Element.
- `extension.valueInteger` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: 1
- `extension._valueInteger` (object)
An extension object type #Element.
- `extension.valueMarkdown` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "Sample markdown text"
- `extension._valueMarkdown` (object)
An extension object type #Element.
- `extension.valueOid` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "urn:oid:1.2.3.4.5"
- `extension._valueOid` (object)
An extension object type #Element.
- `extension.valuePositiveInt` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: 1
- `extension._valuePositiveInt` (object)
An extension object type #Element.
- `extension.valueString` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "example-string"
- `extension._valueString` (object)
An extension object type #Element.
- `extension.valueTime` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "12:00:00"
- `extension._valueTime` (object)
An extension object type #Element.
- `extension.valueUnsignedInt` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
- `extension._valueUnsignedInt` (object)
An extension object type #Element.
- `extension.valueUri` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "https://example.org/resource"
- `extension._valueUri` (object)
An extension object type #Element.
- `extension.valueUrl` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "https://example.org"
- `extension._valueUrl` (object)
An extension object type #Element.
- `extension.valueUuid` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
- `extension._valueUuid` (object)
An extension object type #Element.
- `extension.valueAddress` (object)
An extension object type #Address.
- `extension.valueAge` (object)
An extension object type #Age.
- `extension.valueAnnotation` (object)
An extension object type #Annotation.
- `extension.valueAttachment` (object)
An extension object type #Attachment.
- `extension.valueCodeableConcept` (object)
An extension object type #CodeableConcept.
- `extension.valueCoding` (object)
An extension object type #Coding.
- `extension.valueContactPoint` (object)
An extension object type #ContactPoint.
- `extension.valueCount` (object)
An extension object type #Count.
- `extension.valueDistance` (object)
An extension object type #Distance.
- `extension.valueDuration` (object)
An extension object type #Duration.
- `extension.valueHumanName` (object)
An extension object type #HumanName.
- `extension.valueIdentifier` (object)
An extension object type #Identifier.
- `extension.valueMoney` (object)
An extension object type #Money.
- `extension.valuePeriod` (object)
An extension object type #Period.
- `extension.valueQuantity` (object)
An extension object type #Quantity.
- `extension.valueRange` (object)
An extension object type #Range.
- `extension.valueRatio` (object)
An extension object type #Ratio.
- `extension.valueReference` (object)
An extension object type #Reference.
- `extension.valueSampledData` (object)
An extension object type #SampledData.
- `extension.valueSignature` (object)
An extension object type #Signature.
- `extension.valueTiming` (object)
An extension object type #Timing.
- `extension.valueContactDetail` (object)
An extension object type #ContactDetail.
- `extension.valueContributor` (object)
An extension object type #Contributor.
- `extension.valueDataRequirement` (object)
An extension object type #DataRequirement.
- `extension.valueExpression` (object)
An extension object type #Expression.
- `extension.valueParameterDefinition` (object)
An extension object type #ParameterDefinition.
- `extension.valueRelatedArtifact` (object)
An extension object type #RelatedArtifact.
- `extension.valueTriggerDefinition` (object)
An extension object type #TriggerDefinition.
- `extension.valueUsageContext` (object)
An extension object type #UsageContext.
- `extension.valueDosage` (object)
An extension object type #Dosage.
- `extension.valueMeta` (object)
An extension object type #Meta.
- `modifierExtension` (array)
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).
- `identifier` (array)
A unique identifier assigned to this observation.
- `identifier.use` (any)
The purpose of this identifier.
Enum: "usual", "official", "temp", "secondary", "old"
- `identifier._use` (object)
An extension object type #Element.
- `identifier.type` (object)
An extension object type #CodeableConcept.
- `identifier.system` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `identifier._system` (object)
An extension object type #Element.
- `identifier.value` (string)
An extension object type #string.
Example: "example-string"
- `identifier._value` (object)
An extension object type #Element.
- `identifier.period` (object)
An extension object type #Period.
- `identifier.assigner` (object)
An extension object type #Reference.
- `basedOn` (array)
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.
- `basedOn.reference` (string)
An extension object type #string.
Example: "example-string"
- `basedOn._reference` (object)
An extension object type #Element.
- `basedOn.type` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `basedOn._type` (object)
An extension object type #Element.
- `basedOn.identifier` (object)
An extension object type #Identifier.
- `basedOn.display` (string)
An extension object type #string.
Example: "example-string"
- `basedOn._display` (object)
An extension object type #Element.
- `partOf` (array)
A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
- `status` (any)
The status of the result value.
Enum: "registered", "preliminary", "final", "amended", "corrected", "cancelled", "entered-in-error", "unknown"
- `_status` (object)
Base definition for all elements in a resource.
- `category` (array)
A code that classifies the general type of observation being made.
Example: [{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/observation-category","code":"vital-signs","display":"Vital Signs"}]}]
- `category.coding` (array)
A reference to a code defined by a terminology system.
- `category.text` (string)
An extension object type #string.
Example: "example-string"
- `category._text` (object)
An extension object type #Element.
- `code` (object, required)
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- `subject` (object)
A reference from one resource to another.
- `focus` (array)
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.
- `encounter` (object)
A reference from one resource to another.
- `effectiveDateTime` (string)
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.
Example: "2016-03-28"
- `_effectiveDateTime` (object)
Base definition for all elements in a resource.
- `effectivePeriod` (object)
A time period defined by a start and end date and optionally time.
- `effectivePeriod.start` (string)
An extension object type #dateTime.
Example: "2024-01-01T00:00:00Z"
- `effectivePeriod._start` (object)
An extension object type #Element.
- `effectivePeriod.end` (string)
An extension object type #dateTime.
Example: "2024-01-01T00:00:00Z"
- `effectivePeriod._end` (object)
An extension object type #Element.
- `effectiveTiming` (object)
Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.
- `effectiveTiming.modifierExtension` (array)
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).
- `effectiveTiming.event` (array)
Identifies specific times when the event occurs.
Example: ["2024-01-01T00:00:00Z"]
- `effectiveTiming._event` (array)
Extensions for event
- `effectiveTiming.repeat` (object)
An extension object type #Timing_Repeat.
- `effectiveTiming.code` (object)
An extension object type #CodeableConcept.
- `effectiveInstant` (string)
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.
Example: "example-string"
- `_effectiveInstant` (object)
Base definition for all elements in a resource.
- `issued` (string)
An instant in time - known at least to the second
Example: "2024-01-01T00:00:00Z"
- `_issued` (object)
Base definition for all elements in a resource.
- `performer` (array)
Who was responsible for asserting the observed value as "true".
- `valueQuantity` (object)
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
- `valueQuantity.value` (number)
An extension object type #decimal.
Example: 1.23
- `valueQuantity.comparator` (any)
How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
Enum: "<", "<=", ">=", ">"
- `valueQuantity._comparator` (object)
An extension object type #Element.
- `valueQuantity.unit` (string)
An extension object type #string.
Example: "example-string"
- `valueQuantity._unit` (object)
An extension object type #Element.
- `valueQuantity.code` (string)
An extension object type #code.
Example: "sample-code"
- `valueQuantity._code` (object)
An extension object type #Element.
- `valueCodeableConcept` (object)
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- `valueString` (string)
The information determined as a result of making the observation, if the information has a simple value.
Example: "example-string"
- `_valueString` (object)
Base definition for all elements in a resource.
- `valueBoolean` (boolean)
The information determined as a result of making the observation, if the information has a simple value.
Example: true
- `_valueBoolean` (object)
Base definition for all elements in a resource.
- `valueInteger` (number)
The information determined as a result of making the observation, if the information has a simple value.
Example: 1
- `_valueInteger` (object)
Base definition for all elements in a resource.
- `valueRange` (object)
A set of ordered Quantities defined by a low and high limit.
- `valueRange.low` (object)
An extension object type #Quantity.
- `valueRange.high` (object)
An extension object type #Quantity.
- `valueRatio` (object)
A relationship of two Quantity values - expressed as a numerator and a denominator.
- `valueRatio.numerator` (object)
An extension object type #Quantity.
- `valueRatio.denominator` (object)
An extension object type #Quantity.
- `valueSampledData` (object)
A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.
- `valueSampledData.origin` (object, required)
An extension object type #Quantity.
- `valueSampledData.period` (number)
An extension object type #decimal.
Example: 1.23
- `valueSampledData._period` (object)
An extension object type #Element.
- `valueSampledData.factor` (number)
An extension object type #decimal.
Example: 1.23
- `valueSampledData._factor` (object)
An extension object type #Element.
- `valueSampledData.lowerLimit` (number)
An extension object type #decimal.
Example: 1.23
- `valueSampledData._lowerLimit` (object)
An extension object type #Element.
- `valueSampledData.upperLimit` (number)
An extension object type #decimal.
Example: 1.23
- `valueSampledData._upperLimit` (object)
An extension object type #Element.
- `valueSampledData.dimensions` (integer)
An extension object type #positiveInt.
Example: 1
- `valueSampledData._dimensions` (object)
An extension object type #Element.
- `valueSampledData.data` (string)
An extension object type #string.
Example: "example-string"
- `valueSampledData._data` (object)
An extension object type #Element.
- `valueTime` (string)
The information determined as a result of making the observation, if the information has a simple value.
Example: "12:00:00"
- `_valueTime` (object)
Base definition for all elements in a resource.
- `valueDateTime` (string)
The information determined as a result of making the observation, if the information has a simple value.
Example: "2024-01-01T00:00:00Z"
- `_valueDateTime` (object)
Base definition for all elements in a resource.
- `valuePeriod` (object)
A time period defined by a start and end date and optionally time.
- `dataAbsentReason` (object)
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- `interpretation` (array)
A categorical assessment of an observation value. For example, high, low, normal.
- `note` (array)
Comments about the observation or the results.
- `note.authorReference` (object)
An extension object type #Reference.
- `note.authorString` (string)
The individual responsible for making the annotation.
Example: "example-string"
- `note._authorString` (object)
An extension object type #Element.
- `note.time` (string)
An extension object type #dateTime.
Example: "2024-01-01T00:00:00Z"
- `note._time` (object)
An extension object type #Element.
- `note.text` (object)
An extension object type #markdown.
- `bodySite` (object)
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- `method` (object)
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- `specimen` (object)
A reference from one resource to another.
- `device` (object)
A reference from one resource to another.
- `referenceRange` (array)
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.
- `referenceRange.appliesTo` (array)
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.
- `referenceRange.age` (object)
An extension object type #Range.
- `hasMember` (array)
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.
- `derivedFrom` (array)
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.
- `component` (array)
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.
- `component.dataAbsentReason` (object)
An extension object type #CodeableConcept.
- `component.referenceRange` (array)
Guidance on how to interpret the value by comparison to a normal or recommended range.
## Response 401 fields (application/json):
- `message` (string, required)
Error message indicating unauthorized access.
Example: "Unauthorized"
- `statusCode` (number, required)
HTTP status code for unauthorized access.
Example: 401
## Response 400 fields
## Response 404 fields