FHIR Resource JSON Definitions
Browse the CapabilityStatement, OperationDefinition, SearchParameter, and StructureDefinition JSON files and their customer-observable contract details for this documented release.
Use these release-specific JSON definitions to confirm the supported FHIR contract before implementing a client.
Capability Statements
Official HL7 definitions: CapabilityStatement (FHIR R4 4.0.1); CapabilityStatement (FHIR R6 6.0.0-ballot4).
- ddfs-r4.json —
https://docs.oracle.com/iaas/device-data-fhir/CapabilityStatement/ddfs-r4.json - ddfs-r6.json —
https://docs.oracle.com/iaas/device-data-fhir/CapabilityStatement/ddfs-r6.json
Operation Definitions
Official HL7 definitions: OperationDefinition (FHIR R4 4.0.1); OperationDefinition (FHIR R6 6.0.0-ballot4).
- ddfs-r4-hardDelete.json —
https://docs.oracle.com/iaas/device-data-fhir/OperationDefinition/ddfs-r4-hardDelete.json - ddfs-r4-purgeDeleted.json —
https://docs.oracle.com/iaas/device-data-fhir/OperationDefinition/ddfs-r4-purgeDeleted.json - ddfs-r6-hardDelete.json —
https://docs.oracle.com/iaas/device-data-fhir/OperationDefinition/ddfs-r6-hardDelete.json - ddfs-r6-purgeDeleted.json —
https://docs.oracle.com/iaas/device-data-fhir/OperationDefinition/ddfs-r6-purgeDeleted.json
Search Parameters
Official HL7 definitions: SearchParameter (FHIR R4 4.0.1); SearchParameter (FHIR R6 6.0.0-ballot4).
- ddfs-r4-abatement-date-date.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-abatement-date-date.json - ddfs-r4-activity-token.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-activity-token.json - ddfs-r4-address-city-string.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-address-city-string.json - ddfs-r4-address-postalcode-string.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-address-postalcode-string.json - ddfs-r4-address-state-string.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-address-state-string.json - ddfs-r4-address-string.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-address-string.json - ddfs-r4-agent-reference-identifier-modifier.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-agent-reference-identifier-modifier.json - ddfs-r4-authored-date.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-authored-date.json - ddfs-r4-birthdate-date.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-birthdate-date.json - ddfs-r4-date-date.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-date-date.json - ddfs-r4-death-date-date.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-death-date-date.json - ddfs-r4-device-reference-device-chains.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-device-reference-device-chains.json - ddfs-r4-discharge-disposition-token.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-discharge-disposition-token.json - ddfs-r4-encounter-reference-identifier-chain.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-encounter-reference-identifier-chain.json - ddfs-r4-encounter-reference-identifier-modifier.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-encounter-reference-identifier-modifier.json - ddfs-r4-family-string.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-family-string.json - ddfs-r4-given-string.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-given-string.json - ddfs-r4-last-updated-date.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-last-updated-date.json - ddfs-r4-location-reference-identifier-chain.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-location-reference-identifier-chain.json - ddfs-r4-managing-entity-reference-identifier-modifier.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-managing-entity-reference-identifier-modifier.json - ddfs-r4-manufacturer-string.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-manufacturer-string.json - ddfs-r4-member-reference-identifier-modifier.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-member-reference-identifier-modifier.json - ddfs-r4-model-string.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-model-string.json - ddfs-r4-name-string.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-name-string.json - ddfs-r4-onset-date-date.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-onset-date-date.json - ddfs-r4-organization-reference-identifier-modifier.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-organization-reference-identifier-modifier.json - ddfs-r4-partof-reference-identifier-modifier.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-partof-reference-identifier-modifier.json - ddfs-r4-patient-reference-identifier-chain.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-patient-reference-identifier-chain.json - ddfs-r4-patient-reference-identifier-modifier.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-patient-reference-identifier-modifier.json - ddfs-r4-practitioner-reference-identifier-modifier.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-practitioner-reference-identifier-modifier.json - ddfs-r4-recorded-date-date.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-recorded-date-date.json - ddfs-r4-target-reference-identifier-modifier.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-target-reference-identifier-modifier.json - ddfs-r4-when-date.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r4-when-date.json - ddfs-r6-address-city-string.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-address-city-string.json - ddfs-r6-address-postalcode-string.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-address-postalcode-string.json - ddfs-r6-address-state-string.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-address-state-string.json - ddfs-r6-address-string.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-address-string.json - ddfs-r6-agent-reference-identifier-modifier.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-agent-reference-identifier-modifier.json - ddfs-r6-birthdate-date.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-birthdate-date.json - ddfs-r6-date-date.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-date-date.json - ddfs-r6-death-date-date.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-death-date-date.json - ddfs-r6-device-reference-device-chains.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-device-reference-device-chains.json - ddfs-r6-discharge-disposition-token.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-discharge-disposition-token.json - ddfs-r6-encounter-reference-identifier-chain.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-encounter-reference-identifier-chain.json - ddfs-r6-family-string.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-family-string.json - ddfs-r6-form-token.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-form-token.json - ddfs-r6-given-string.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-given-string.json - ddfs-r6-identifier-token.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-identifier-token.json - ddfs-r6-last-updated-date.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-last-updated-date.json - ddfs-r6-location-reference-identifier-chain.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-location-reference-identifier-chain.json - ddfs-r6-manufacturer-string.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-manufacturer-string.json - ddfs-r6-model-string.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-model-string.json - ddfs-r6-name-string.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-name-string.json - ddfs-r6-owner-reference-identifier-modifier.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-owner-reference-identifier-modifier.json - ddfs-r6-partof-reference-identifier-modifier.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-partof-reference-identifier-modifier.json - ddfs-r6-patient-reference-identifier-chain.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-patient-reference-identifier-chain.json - ddfs-r6-patient-reference-identifier-modifier.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-patient-reference-identifier-modifier.json - ddfs-r6-practitioner-reference-identifier-modifier.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-practitioner-reference-identifier-modifier.json - ddfs-r6-status-token.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-status-token.json - ddfs-r6-subject-reference-identifier-modifier.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-subject-reference-identifier-modifier.json - ddfs-r6-target-reference-identifier-modifier.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-target-reference-identifier-modifier.json - ddfs-r6-when-date.json —
https://docs.oracle.com/iaas/device-data-fhir/SearchParameter/ddfs-r6-when-date.json
Structure Definitions
Official HL7 definitions: StructureDefinition (FHIR R6 6.0.0-ballot4).
- subscription-oci-vault-secret.json —
https://docs.oracle.com/iaas/device-data-fhir/StructureDefinition/subscription-oci-vault-secret.json
Operation contract details
| Version | Operation | FHIR ID | Definition name | Title | Artifact version | Status | Experimental | Published | Publisher | Kind | Affects state | Invocation scope | Resources | Description |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| R4 | hardDelete | ddfs-r4-hardDelete |
DDFSR4HardDelete | DDFS R4 Hard Delete | 4.0.1 | active | No | 2026-06-01T00:00:00Z | Oracle | operation | Yes | instance | Condition, Device, DiagnosticReport, Encounter, Endpoint, Group, Location, Observation, Organization, Patient, Practitioner, PractitionerRole, Provenance, RelatedPerson, ServiceRequest, Specimen | Permanently removes one deleted resource instance. This instance-level operation returns an OperationOutcome and requires both matching system/{Resource}.d delete authority and the exact custom scope https://docs.oracle.com/iaas/device-data-fhir/scopes/hard-delete. |
| R4 | purgeDeleted | ddfs-r4-purgeDeleted |
DDFSR4PurgeDeleted | DDFS R4 Purge Deleted | 4.0.1 | active | No | 2026-06-01T00:00:00Z | Oracle | operation | Yes | type | Condition, Device, DiagnosticReport, Encounter, Endpoint, Group, Location, Observation, Organization, Patient, Practitioner, PractitionerRole, Provenance, RelatedPerson, ServiceRequest, Specimen | Permanently purges deleted resources of the requested type that were deleted before the required before dateTime, optionally limited to 1 through 50 resources. Inputs are supplied in the POST FHIR Parameters body. This type-level operation returns an OperationOutcome and requires both matching system/{Resource}.d delete authority and the exact custom scope https://docs.oracle.com/iaas/device-data-fhir/scopes/hard-delete. |
| R6 | hardDelete | ddfs-r6-hardDelete |
DDFSR6HardDelete | DDFS R6 Hard Delete | 6.0.0-ballot4 | active | No | 2026-06-01T00:00:00Z | Oracle | operation | Yes | instance | Device, DeviceAssociation, Encounter, Location, Observation, Patient, Practitioner, PractitionerRole, Provenance, Subscription, SubscriptionTopic | Permanently removes one deleted resource instance. This instance-level operation returns an OperationOutcome and requires both matching system/{Resource}.d delete authority and the exact custom scope https://docs.oracle.com/iaas/device-data-fhir/scopes/hard-delete. |
| R6 | purgeDeleted | ddfs-r6-purgeDeleted |
DDFSR6PurgeDeleted | DDFS R6 Purge Deleted | 6.0.0-ballot4 | active | No | 2026-06-01T00:00:00Z | Oracle | operation | Yes | type | Device, DeviceAssociation, Encounter, Location, Observation, Patient, Practitioner, PractitionerRole, Provenance, Subscription, SubscriptionTopic | Permanently purges deleted resources of the requested type that were deleted before the required before dateTime, optionally limited to 1 through 50 resources. Inputs are supplied in the POST FHIR Parameters body. This type-level operation returns an OperationOutcome and requires both matching system/{Resource}.d delete authority and the exact custom scope https://docs.oracle.com/iaas/device-data-fhir/scopes/hard-delete. |
Input and output cardinalities use the minimum and maximum values declared by each OperationDefinition.
| Version | Operation | Parameter | Use | Min | Max | Type | Search type | Target profiles | Description |
|---|---|---|---|---|---|---|---|---|---|
| R4 | $hardDelete |
return |
out | 1 | 1 | OperationOutcome | — | OperationOutcome describing the hard-delete result. | |
| R4 | $purgeDeleted |
before |
in | 1 | 1 | dateTime | — | Required FHIR dateTime cutoff supplied as Parameters.parameter.valueDateTime; deleted resources before this instant are purged. | |
| R4 | $purgeDeleted |
limit |
in | 0 | 1 | integer | — | Optional maximum supplied as Parameters.parameter.valueInteger. The route accepts values from 1 through 50. | |
| R4 | $purgeDeleted |
return |
out | 1 | 1 | OperationOutcome | — | OperationOutcome describing the purge result. | |
| R6 | $hardDelete |
return |
out | 1 | 1 | OperationOutcome | — | OperationOutcome describing the hard-delete result. | |
| R6 | $purgeDeleted |
before |
in | 1 | 1 | dateTime | — | Required FHIR dateTime cutoff supplied as Parameters.parameter.valueDateTime; deleted resources before this instant are purged. | |
| R6 | $purgeDeleted |
limit |
in | 0 | 1 | integer | — | Optional maximum supplied as Parameters.parameter.valueInteger. The route accepts values from 1 through 50. | |
| R6 | $purgeDeleted |
return |
out | 1 | 1 | OperationOutcome | — | OperationOutcome describing the purge result. |
Structure definition contract details
| Version | Definition | FHIR ID | Definition name | Title | Artifact version | Status | Experimental | Published | Publisher | Description | FHIR version | Kind | Type | Abstract | Base definition | Derivation | Context |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| R6 | subscription-oci-vault-secret.json | subscription-oci-vault-secret |
SubscriptionOciVaultSecret | Subscription OCI Vault Secret | 1.0.0 | active | No | 2026-08-06 | Oracle DDFS | Extension to allow a Subscription to reference an OCI Vault secret OCID whose resolved value is used as the Authorization header for rest-hook deliveries. | 6.0.0-ballot4 | complex-type | Extension | No | FHIR definition | constraint | element: Subscription |
| Definition | Element ID | Path | Min | Max | Type | Fixed URI | Summary | Definition text | Other differential constraints |
|---|---|---|---|---|---|---|---|---|---|
| subscription-oci-vault-secret.json | Extension | Extension | 0 | 1 | — | OCI Vault secret for rest-hook Authorization header | Reference to an OCI Vault secret OCID whose value will be used as the outbound Authorization header for rest-hook deliveries. | ||
| subscription-oci-vault-secret.json | Extension.url | Extension.url | Inherited from base definition | Inherited from base definition | — | https://docs.oracle.com/iaas/device-data-fhir/StructureDefinition/subscription-oci-vault-secret.json | |||
| subscription-oci-vault-secret.json | Extension.value[x] | Extension.value[x] | 1 | 1 | string | OCI Secret OCID | The OCID of the OCI Vault secret. The resolved secret value at dispatch time is used verbatim as the Authorization header value (e.g., 'Bearer <token>'). |