Observation
The Observation resource represents recorded measurements, form values, and score interpretations in Open Aidn.
Open Aidn currently exposes selected fields from the base HL7 FHIR R4 Observation resource. A formal Aidn profile may be published later.
Standards and profiles
- HL7 FHIR R4: Observation
- HL7 FHIR R4 search: FHIR search
Endpoints
| Method | Path | Required scope | Description |
|---|---|---|---|
POST |
/Observation/_search |
observation.search |
Search using application/x-www-form-urlencoded body parameters. |
GET |
/Observation/{formId}.{variableId} |
observation.read |
Read one Observation by composite Observation ID. |
Search responses are returned as FHIR Bundle resources with type set to searchset.
Search parameters
| Parameter | Type | Description |
|---|---|---|
patient.Identifier |
identifier | Patient identifier used to filter observations for one patient. |
code |
token, repeatable | Observation code filter. |
_include |
token, repeatable | Adds supported referenced resources to the response bundle. |
patient.Identifier is required for search.
Supported includes
_include value |
Included resource | Description |
|---|---|---|
Observation:subject |
Patient |
Adds referenced patient resources. |
Observation:performer |
Practitioner |
Adds referenced performer resources. |
Response fields
Open Aidn may expand the response over time, but integrations should currently expect data in these fields:
| Field | Description |
|---|---|
id |
Observation identifier formatted as {formId}.{variableId}. |
meta.lastUpdated |
Last update timestamp when available. |
status |
FHIR Observation status, such as final, preliminary, or entered-in-error. |
code |
Observation code and display text. |
effectiveDateTime |
Time the observation applies to. |
subject.reference |
Reference to the patient. |
performer.reference |
Reference to the practitioner. |
value[x] |
Recorded value, such as text, quantity, date/time, or coded choice. |
component |
Score interpretation components when available. |
derivedFrom |
References to derived observations when available. |
Example search
POST /Observation/_search HTTP/1.1
Host: <OPEN_AIDN_FHIR_HOST>
Accept: application/fhir+json
Content-Type: application/x-www-form-urlencoded
Authorization: Bearer <ACCESS_TOKEN>
patient.Identifier=<PATIENT_IDENTIFIER>&code=<SYSTEM>|<CODE>&_include=Observation:performerThe response is a FHIR search bundle with matching Observation resources and any requested includes.