FHIR R6 Resources
Supported FHIR R6 resources.
DDFS OAuth access for R6 follows the scope planning guidance described in the DDFS authentication and scope guidance section and the scope matrix.
Create a DDFS instance, to get an FHIR R6 endpoint, see Getting an Instance's Details:
https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r6-ballot4Authorization
For complete scope configuration examples, see Common Scope Configuration Examples.
| Context | Scope form |
|---|---|
| Resource-server definition | system/... |
| Client grant/token request | ddfssystem/... |
Issued token's scope claim | system/... |
The following client grant and token-request examples use the fixed ddfs prefix. Resource-server definitions and issued access-token scope claims use the corresponding canonical system/... form.
- Clinical content (Patient, Observation, Encounter):
ddfssystem/{Resource}.readfor reads and searches, andddfssystem/{Resource}.writewhen the integration creates, updates, or deletes data. - Device and associations:
ddfssystem/Device.*andddfssystem/DeviceAssociation.*. - Subscriptions and topics:
ddfssystem/Subscription.*andddfssystem/SubscriptionTopic.*for notification workflows. - Subscription status: request
ddfssystem/Subscription.sfor the type-levelSubscription/$statusoperation orddfssystem/Subscription.rfor the instance-level operation. Issued tokens use the corresponding canonicalsystem/...scope. A separate SubscriptionStatus scope is not required. Missing the required Subscription permission results in HTTP 403; parameterized scopes continue to constrain the authorized results. - Directory data (Location, Practitioner, PractitionerRole):
ddfssystem/{Resource}.readand write authorization when applicable. - Provenance:
ddfssystem/Provenance.readandddfssystem/Provenance.write.
FHIR Contract Details
The following support matrix is generated from ddfs-r6.json. Check the live metadata endpoint before enabling optional client behavior.
| Resource | Interactions | Operations | Search parameters | Includes | Reverse includes |
|---|---|---|---|---|---|
Device |
create, read, vread, update, delete, search-type | $hardDelete, $purgeDeleted | _count, _total, _id, _lastUpdated, _profile, _tag, patient, status, type, manufacturer, model | — | Provenance:target |
DeviceAssociation |
create, read, vread, update, delete, search-type | $hardDelete, $purgeDeleted | _count, _total, _id, _lastUpdated, _profile, _tag, date, device, patient, status, subject | — | 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 |
Location |
create, read, vread, update, delete, search-type | $hardDelete, $purgeDeleted | _count, _total, _id, _lastUpdated, _profile, _tag, identifier, status, partof, form, name, address, address-city, address-state, address-postalcode | — | Provenance:target |
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 |
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 | — | Provenance:target |
PractitionerRole |
create, read, vread, update, delete, search-type | $hardDelete, $purgeDeleted | _count, _total, _id, _lastUpdated, _profile, _tag, practitioner, specialty | — | Provenance:target |
Provenance |
create, read, vread, update, delete, search-type | $hardDelete, $purgeDeleted | _count, _total, _id, _lastUpdated, _profile, _tag, activity, agent, target, when | — | — |
Subscription |
create, read, vread, update, delete, search-type | $hardDelete, $purgeDeleted, $status | _count, _total, _id, _lastUpdated, _profile, _tag, owner, topic, url, status | — | Provenance:target |
SubscriptionTopic |
create, read, vread, update, delete, search-type | $hardDelete, $purgeDeleted | _count, _total, _id, _lastUpdated, _profile, _tag, url | — | Provenance:target |
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 |
|---|---|---|---|---|---|---|---|---|---|---|
Device |
http://hl7.org/fhir/StructureDefinition/Device | Not declared | versioned | Yes | No | No | not-supported | No | Not declared | not-supported |
DeviceAssociation |
http://hl7.org/fhir/StructureDefinition/DeviceAssociation | Not declared | versioned | Yes | No | No | not-supported | No | Not declared | not-supported |
Encounter |
http://hl7.org/fhir/StructureDefinition/Encounter | Not declared | versioned | Yes | No | No | not-supported | No | Not declared | not-supported |
Location |
http://hl7.org/fhir/StructureDefinition/Location | Not declared | versioned | Yes | No | No | not-supported | No | Not declared | not-supported |
Observation |
http://hl7.org/fhir/StructureDefinition/Observation | Not declared | versioned | Yes | No | No | not-supported | No | Not declared | not-supported |
Patient |
http://hl7.org/fhir/StructureDefinition/Patient | Not declared | versioned | Yes | No | No | not-supported | No | Not declared | not-supported |
Practitioner |
http://hl7.org/fhir/StructureDefinition/Practitioner | Not declared | versioned | Yes | No | No | not-supported | No | Not declared | not-supported |
PractitionerRole |
http://hl7.org/fhir/StructureDefinition/PractitionerRole | Not declared | versioned | Yes | No | No | not-supported | No | Not declared | not-supported |
Provenance |
http://hl7.org/fhir/StructureDefinition/Provenance | Not declared | versioned | Yes | No | No | not-supported | No | Not declared | not-supported |
Subscription |
http://hl7.org/fhir/StructureDefinition/Subscription | Not declared | versioned | Yes | No | No | not-supported | No | Not declared | not-supported |
SubscriptionTopic |
http://hl7.org/fhir/StructureDefinition/SubscriptionTopic | Not declared | versioned | Yes | No | No | not-supported | No | Not declared | not-supported |