Search RelatedPerson

Search or list FHIR R4 Related Person resources.

Endpoint

GET /api/fhir/r4/RelatedPerson

POST /api/fhir/r4/RelatedPerson/_search

For GET, send search parameters in the query string. For POST, send the same supported parameters in a form-URL-encoded body with Content-Type: application/x-www-form-urlencoded. POST search returns a search-result Bundle and requires the same search authorization as GET. See POST search example.

Base URL: https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r4

Parameters


Parameter	In	Required	Type	Description
`_count`	query	false	number	Page size. Use a positive number to request the page size.
`_total`	query	false	token	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-r4-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.
`patient`	query	false	reference	DDFS supports patient as a reference search parameter for the listed resource types. The :identifier modifier is supported; chained search parameters are not advertised for this definition. Use a FHIR reference such as Patient/{id}. Use supported reference modifiers or chains only when advertised. Modifiers: :identifier Definition: https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-patient-reference-identifier-modifier.json.
`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-r4-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/RelatedPerson.s`
Client grant/token request	`ddfssystem/RelatedPerson.s`
Issued token's `scope` claim	`system/RelatedPerson.s`

Behavior

Uses the advertised type-level RelatedPerson search interaction.

FHIR Definition

Canonical: https://hl7.org/fhir/R4/relatedperson.html

Oracle Cloud Infrastructure Documentation