Search Observation
Search or list FHIR R6 Observation resources.
Endpoint
GET /api/fhir/r6-ballot4/Observation
Base URL: https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r6-ballot4
Parameters
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
_count |
query | false | special | Page size. Use a positive number to request the page size. |
_total |
query | false | special | Requests search total handling. Use a FHIR total mode value when total handling is needed. |
_id |
query | false | token | Logical resource id. Use a resource logical id. Definition: http://hl7.org/fhir/SearchParameter/Resource-id. |
_lastUpdated |
query | false | date | DDFS supports _lastUpdated as a date search parameter for the listed resource types. Date comparators eq, ne, gt, lt, ge, le, sa, eb, and ap are supported. Use a FHIR date, instant, or supported date prefix. Comparators: eq, ne, gt, lt, ge, le, sa, eb, ap Definition: https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-last-updated-date.json. |
_profile |
query | false | uri | Profile URI filter. Use a profile URI. Definition: http://hl7.org/fhir/SearchParameter/Resource-profile. |
_tag |
query | false | token | Resource tag token filter. Use a token in system|code form when a system is available. Definition: http://hl7.org/fhir/SearchParameter/Resource-tag. |
category |
query | false | token | Filters by category. Use a token value, such as system|code when a system applies. Definition: http://hl7.org/fhir/SearchParameter/Observation-category. |
code |
query | false | token | Filters by code. Use a token value, such as system|code when a system applies. Definition: http://hl7.org/fhir/SearchParameter/clinical-code. |
date |
query | false | date | DDFS supports date as a date search parameter for the listed resource types. Date comparators eq, ne, gt, lt, ge, le, sa, eb, and ap are supported. Use a FHIR date value such as 2020-01-01. Supported prefixes are listed when advertised by the SearchParameter JSON. Comparators: eq, ne, gt, lt, ge, le, sa, eb, ap Definition: https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-date-date.json. |
device |
query | false | reference | DDFS supports device as a Device reference search parameter for the listed resource types. The :identifier modifier is supported. Supported one-hop Device chains are .identifier, .manufacturer, and .model. The :exact modifier is supported by the target Device manufacturer and model SearchParameters. Use a FHIR reference such as Device/{id}. Use supported reference modifiers or chains only when advertised. Modifiers: :identifier Chains: identifier, manufacturer, model Definition: https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-device-reference-device-chains.json. |
encounter |
query | false | reference | DDFS supports encounter as a reference search parameter for the listed resource types. The :identifier modifier and the .identifier chain are supported. Use a FHIR reference such as Encounter/{id}. Use supported reference modifiers or chains only when advertised. Modifiers: :identifier Chains: identifier Definition: https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-encounter-reference-identifier-chain.json. |
patient |
query | false | reference | DDFS supports patient as a reference search parameter for the listed resource types. The :identifier modifier and the .identifier chain are supported. Use a FHIR reference in resourceType/{id} form. Use supported reference modifiers or chains only when advertised. Modifiers: :identifier Chains: identifier Definition: https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-patient-reference-identifier-chain.json. |
specimen |
query | false | reference | Filters by an exact Specimen reference such as Specimen/{id}, a valid specimen-only Group reference such as Group/{id}, or by specimen:identifier. Supply one value per request; repeated values and comma-delimited alternatives are not supported. Chains and modifiers other than :identifier are not supported. Definition: http://hl7.org/fhir/SearchParameter/Observation-specimen. |
status |
query | false | token | Filters by status. Use a token value, such as system|code when a system applies. Definition: http://hl7.org/fhir/SearchParameter/Observation-status. |
_revinclude |
query | false | special | Includes Provenance resources whose target references a matching resource. Use only reverse-include values advertised for this resource. Supported values: Provenance:target. |
Authorization
The supported authorization model uses OAuth 2.0 scopes issued by OCI Identity Domains. Send the access token as a bearer token. Resource-server definitions and issued access-token claims use canonical system/... scopes. Client grants and token requests use the corresponding ddfssystem/... form. For examples, see Reference: Authentication and Scopes.
| Context | Scope form |
|---|---|
| Resource-server definition | system/Observation.s |
| Client grant/token request | ddfssystem/Observation.s |
Issued token's scope claim |
system/Observation.s |
Behavior
Uses the advertised type-level Observation search interaction.
FHIR Definition
Canonical: https://hl7.org/fhir/6.0.0-ballot4/observation.html