Search Patient
Search or list FHIR R6 Patient resources.
Endpoint
GET /api/fhir/r6-ballot4/Patient
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. |
birthdate |
query | false | date | DDFS supports birthdate 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-birthdate-date.json. |
death-date |
query | false | date | DDFS supports death-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-death-date-date.json. |
family |
query | false | string | DDFS supports family as a string search parameter for the listed resource types. Only the :exact modifier is supported. Use a string value. Supported string modifiers are listed when advertised. Modifiers: :exact Definition: https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-family-string.json. |
given |
query | false | string | DDFS supports given as a string search parameter for the listed resource types. Only the :exact modifier is supported. Use a string value. Supported string modifiers are listed when advertised. Modifiers: :exact Definition: https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-given-string.json. |
identifier |
query | false | token | Filters by identifier. Use a token value, such as system|code when a system applies. Definition: http://hl7.org/fhir/SearchParameter/Patient-identifier. |
name |
query | false | string | DDFS supports name as a string search parameter for the listed resource types. Only the :exact modifier is supported. Use a string value. Supported string modifiers are listed when advertised. Modifiers: :exact Definition: https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-name-string.json. |
_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/Patient.s |
| Client grant/token request | ddfssystem/Patient.s |
Issued token's scope claim |
system/Patient.s |
Behavior
Uses the advertised type-level Patient search interaction.
FHIR Definition
Canonical: https://hl7.org/fhir/6.0.0-ballot4/patient.html