FHIR R4 Resources
FHIR R4 resources
These resources use DDFS OAuth scopes documented in the DDFS OAuth scope matrix. Each linked topic lists resource-specific authorization scopes plus request and response details.
Create a DDFS instance, to get an FHIR R4 endpoint, see Getting an Instance's Details:
https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r4Authorization
For the complete scope configuration model, see Where Scopes Are Configured and Requested.
| Context | Scope form |
|---|---|
| Resource-server definition | system/... |
| Client grant/token request | ddfssystem/... |
Issued token's scope claim | system/... |
The following guidance uses the canonical system/... form used in resource-server definitions and issued access-token scope claims. When configuring an OCI Identity Domains client, grant and request the corresponding fixed-prefix form, such as ddfssystem/Patient.rs. Grant only the resource-specific scopes required by the client workflow.
| Resource group | Canonical scope guidance |
|---|---|
| Patient, Encounter, Observation, Condition, DiagnosticReport, ServiceRequest, Specimen, Group, RelatedPerson | system/{resource}.rs or system/{resource}.read for read and search access. Add system/{resource}.write only when the integration creates, updates, or logically deletes data. |
| Organization, Practitioner, PractitionerRole, Endpoint, Location | system/{resource}.rs or system/{resource}.read for read and search access. Add system/{resource}.write only when the integration creates, updates, or logically deletes data. |
| Device | system/Device.rs or system/Device.read for read and search access. Add system/Device.write only when the integration creates, updates, or logically deletes data. |
| Provenance | system/Provenance.rs or system/Provenance.read for read and search access. Add system/Provenance.write only when applicable. |
Hard-delete and purge-deleted operations also require the canonical DDFS hard-delete scope. See Custom Hard-Delete Scope.
FHIR Contract Details
The following support matrix is generated from ddfs-r4.json. Check GET /api/fhir/r4/metadata before enabling optional client behavior.
| Resource | Interactions | Operations | Search parameters | Includes | Reverse includes |
|---|---|---|---|---|---|
Condition |
create, read, vread, update, delete, search-type | $hardDelete, $purgeDeleted | _count, _total, _id, _lastUpdated, _profile, _tag, abatement-date, category, clinical-status, code, encounter, onset-date, patient, recorded-date | — | Provenance:target |
Device |
create, read, vread, update, delete, search-type | $hardDelete, $purgeDeleted | _count, _total, _id, _lastUpdated, _profile, _tag, patient, status, type, manufacturer, model | — | Provenance:target |
DiagnosticReport |
create, read, vread, update, delete, search-type | $hardDelete, $purgeDeleted | _count, _total, _id, _lastUpdated, _profile, _tag, category, code, date, patient, status | — | Provenance:target |
Encounter |
create, read, vread, update, delete, search-type | $hardDelete, $purgeDeleted | _count, _total, _id, _lastUpdated, _profile, _tag, class, date, discharge-disposition, identifier, location, patient, status, type | — | Provenance:target |
Endpoint |
create, read, vread, update, delete, search-type | $hardDelete, $purgeDeleted | _count, _total, _id, _lastUpdated, _profile, _tag, status, organization, connection-type, payload-type, name, identifier | — | — |
Group |
create, read, vread, update, delete, search-type | $hardDelete, $purgeDeleted | _count, _total, _id, _lastUpdated, _profile, _tag, actual, code, identifier, managing-entity, member, type | — | — |
Location |
create, read, vread, update, delete, search-type | $hardDelete, $purgeDeleted | _count, _total, _id, _lastUpdated, _profile, _tag, identifier, status, partof, name, address, address-city, address-state, address-postalcode | — | — |
Observation |
create, read, vread, update, delete, search-type | $hardDelete, $purgeDeleted | _count, _total, _id, _lastUpdated, _profile, _tag, category, code, date, device, encounter, patient, specimen, status | — | Provenance:target |
Organization |
create, read, vread, update, delete, search-type | $hardDelete, $purgeDeleted | _count, _total, _id, _lastUpdated, _profile, _tag, address, name | — | — |
Patient |
create, read, vread, update, delete, search-type | $hardDelete, $purgeDeleted | _count, _total, _id, _lastUpdated, _profile, _tag, birthdate, death-date, family, given, identifier, name | — | Provenance:target |
Practitioner |
create, read, vread, update, delete, search-type | $hardDelete, $purgeDeleted | _count, _total, _id, _lastUpdated, _profile, _tag, identifier, name | — | — |
PractitionerRole |
create, read, vread, update, delete, search-type | $hardDelete, $purgeDeleted | _count, _total, _id, _lastUpdated, _profile, _tag, practitioner, specialty | PractitionerRole:practitioner, PractitionerRole:endpoint | — |
Provenance |
create, read, vread, update, delete, search-type | $hardDelete, $purgeDeleted | _count, _total, _id, _lastUpdated, _profile, _tag, activity, agent, target, when | — | — |
RelatedPerson |
create, read, vread, update, delete, search-type | $hardDelete, $purgeDeleted | _count, _total, _id, _lastUpdated, _profile, _tag, patient, name | — | Provenance:target |
ServiceRequest |
create, read, vread, update, delete, search-type | $hardDelete, $purgeDeleted | _count, _total, _id, _lastUpdated, _profile, _tag, authored, category, code, patient, status | — | Provenance:target |
Specimen |
create, read, vread, update, delete, search-type | $hardDelete, $purgeDeleted | _count, _total, _id, _lastUpdated, _profile, _tag, patient | — | — |
Resource behavior declarations
Not declared means that the CapabilityStatement does not make a declaration for that field; clients must not infer support.
| Resource | Profile | Supported profiles | Versioning | Read history | Update create | Conditional create | Conditional read | Conditional update | Conditional patch | Conditional delete |
|---|---|---|---|---|---|---|---|---|---|---|
Condition |
http://hl7.org/fhir/StructureDefinition/Condition | — | versioned | Yes | No | No | not-supported | No | Not declared | not-supported |
Device |
http://hl7.org/fhir/StructureDefinition/Device | — | versioned | Yes | No | No | not-supported | No | Not declared | not-supported |
DiagnosticReport |
http://hl7.org/fhir/StructureDefinition/DiagnosticReport | — | versioned | Yes | No | No | not-supported | No | Not declared | not-supported |
Encounter |
http://hl7.org/fhir/StructureDefinition/Encounter | — | versioned | Yes | No | No | not-supported | No | Not declared | not-supported |
Endpoint |
http://hl7.org/fhir/StructureDefinition/Endpoint | — | versioned | Yes | No | No | not-supported | No | Not declared | not-supported |
Group |
http://hl7.org/fhir/StructureDefinition/Group | — | versioned | Yes | No | No | not-supported | No | Not declared | not-supported |
Location |
http://hl7.org/fhir/StructureDefinition/Location | — | versioned | Yes | No | No | not-supported | No | Not declared | not-supported |
Observation |
http://hl7.org/fhir/StructureDefinition/Observation | — | versioned | Yes | No | No | not-supported | No | Not declared | not-supported |
Organization |
http://hl7.org/fhir/StructureDefinition/Organization | — | versioned | Yes | No | No | not-supported | No | Not declared | not-supported |
Patient |
http://hl7.org/fhir/StructureDefinition/Patient | — | versioned | Yes | No | No | not-supported | No | Not declared | not-supported |
Practitioner |
http://hl7.org/fhir/StructureDefinition/Practitioner | — | versioned | Yes | No | No | not-supported | No | Not declared | not-supported |
PractitionerRole |
http://hl7.org/fhir/StructureDefinition/PractitionerRole | — | versioned | Yes | No | No | not-supported | No | Not declared | not-supported |
Provenance |
http://hl7.org/fhir/StructureDefinition/Provenance | — | versioned | Yes | No | No | not-supported | No | Not declared | not-supported |
RelatedPerson |
http://hl7.org/fhir/StructureDefinition/RelatedPerson | — | versioned | Yes | No | No | not-supported | No | Not declared | not-supported |
ServiceRequest |
http://hl7.org/fhir/StructureDefinition/ServiceRequest | — | versioned | Yes | No | No | not-supported | No | Not declared | not-supported |
Specimen |
http://hl7.org/fhir/StructureDefinition/Specimen | — | versioned | Yes | No | No | not-supported | No | Not declared | not-supported |