FHIR R4 Resources

Choose FHIR R4 4.0.1 resources for your application and find their supported operations.

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/r4

Choose a Resource

Use the following table to choose resources for your application. The operation links open each resource's category page, which links to its supported endpoints, parameters, authorization scopes and response codes. This catalog covers FHIR R4 4.0.1; for the separate R6 resource set, see FHIR R6 Resources.

Resource	Customer purpose	FHIR version	Operations
`AllergyIntolerance`	Record a patient's allergies, intolerances and associated reactions.	R4 4.0.1	AllergyIntolerance operations
`CarePlan`	Describe a plan of care, its intended activities and the patient or group it concerns.	R4 4.0.1	CarePlan operations
`CareTeam`	Identify the participants involved in a patient's care.	R4 4.0.1	CareTeam operations
`Composition`	Organize clinical information into an authored, sectioned document structure.	R4 4.0.1	Composition operations
`Condition`	Record a clinical problem, diagnosis or health concern.	R4 4.0.1	Condition operations
`Device`	Identify a medical device associated with patient care or measurements.	R4 4.0.1	Device operations
`DiagnosticReport`	Record diagnostic report findings and references to supporting results.	R4 4.0.1	DiagnosticReport operations
`DocumentReference`	Describe a clinical document and its attachment content or location.	R4 4.0.1	DocumentReference operations
`Encounter`	Record the care encounter that provides context for clinical information.	R4 4.0.1	Encounter operations
`Endpoint`	Describe a technical connection point for exchanging information.	R4 4.0.1	Endpoint operations
`FamilyMemberHistory`	Record health conditions reported for a patient's family members.	R4 4.0.1	FamilyMemberHistory operations
`Group`	Represent a collection of people or other entities, such as a patient cohort.	R4 4.0.1	Group operations
`Immunization`	Record a vaccination event and its associated clinical details.	R4 4.0.1	Immunization operations
`Location`	Describe a place where care is provided or a device is located.	R4 4.0.1	Location operations
`Medication`	Describe a medication product referenced by other clinical records.	R4 4.0.1	Medication operations
`MedicationRequest`	Record a medication order or request and its prescribing instructions.	R4 4.0.1	MedicationRequest operations
`MedicationStatement`	Record a statement about a patient's medication use.	R4 4.0.1	MedicationStatement operations
`Observation`	Record measurements and clinical findings, including device readings and laboratory results.	R4 4.0.1	Observation operations
`Organization`	Identify an organization involved in care or information exchange.	R4 4.0.1	Organization operations
`Patient`	Identify the person who receives care and associate records with that person.	R4 4.0.1	Patient operations
`Practitioner`	Identify a person involved in providing healthcare.	R4 4.0.1	Practitioner operations
`PractitionerRole`	Describe a practitioner's role, specialty and organizational context.	R4 4.0.1	PractitionerRole operations
`Procedure`	Record an action performed as part of patient care.	R4 4.0.1	Procedure operations
`Provenance`	Record the people, organizations or activities responsible for resource content.	R4 4.0.1	Provenance operations
`RelatedPerson`	Identify a person related to the patient, such as a family member or caregiver.	R4 4.0.1	RelatedPerson operations
`ServiceRequest`	Record a request for a clinical service, such as a procedure or diagnostic investigation.	R4 4.0.1	ServiceRequest operations
`Specimen`	Describe a biological sample associated with diagnostic work.	R4 4.0.1	Specimen operations

For examples that combine medication records, care plans and clinical documents with device observations, see Connected Clinical Workflows. Your application coordinates these records and any clinical actions; storing a resource does not execute the workflow it describes.

Authorization

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
AllergyIntolerance, CarePlan, CareTeam, Composition, Condition, DiagnosticReport, DocumentReference, Encounter, FamilyMemberHistory, Group, Immunization, Medication, MedicationRequest, MedicationStatement, Observation, Patient, Procedure, RelatedPerson, ServiceRequest, Specimen	`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
`Composition`	create, read, vread, update, delete, search-type	$hardDelete, $purgeDeleted	identifier, _count, _total, _id, _lastUpdated, _profile, _tag, category, type, status, date, patient	—	Provenance:target
`Medication`	create, read, vread, update, delete, search-type	$hardDelete, $purgeDeleted	identifier, _count, _total, _id, _lastUpdated, _profile, _tag, code	—	—
`Immunization`	create, read, vread, update, delete, search-type	$hardDelete, $purgeDeleted	_count, _total, _id, _lastUpdated, _profile, _tag, identifier, patient, status, date, vaccine-code	—	Provenance:target
`AllergyIntolerance`	create, read, vread, update, delete, search-type	$hardDelete, $purgeDeleted	identifier, _count, _total, _id, _lastUpdated, _profile, _tag, category, clinical-status, code, patient, verification-status	—	Provenance:target
`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
`DocumentReference`	create, read, vread, update, delete, search-type	$hardDelete, $purgeDeleted	_count, _total, _id, _lastUpdated, _profile, _tag, identifier, patient, category, type, status, date, period	—	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	—	—
`CareTeam`	create, read, vread, update, delete, search-type	$hardDelete, $purgeDeleted	identifier, _count, _total, _id, _lastUpdated, _profile, _tag, patient, status	—	Provenance:target
`CarePlan`	create, read, vread, update, delete, search-type	$hardDelete, $purgeDeleted	identifier, _count, _total, _id, _lastUpdated, _profile, _tag, patient, category, status, date	—	Provenance:target
`FamilyMemberHistory`	create, read, vread, update, delete, search-type	$hardDelete, $purgeDeleted	identifier, _count, _total, _id, _lastUpdated, _profile, _tag, code, patient, status, relationship	—	Provenance:target
`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	—	—
`MedicationStatement`	create, read, vread, update, delete, search-type	$hardDelete, $purgeDeleted	identifier, _count, _total, _id, _lastUpdated, _profile, _tag, code, patient, status, medication, effective	—	Provenance:target
`MedicationRequest`	create, read, vread, update, delete, search-type	$hardDelete, $purgeDeleted	identifier, _count, _total, _id, _lastUpdated, _profile, _tag, code, patient, status, intent, medication, authoredon	—	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
`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	—
`Procedure`	create, read, vread, update, delete, search-type	$hardDelete, $purgeDeleted	identifier, _count, _total, _id, _lastUpdated, _profile, _tag, code, patient, status, date	—	Provenance:target
`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
`MedicationRequest`	http://hl7.org/fhir/StructureDefinition/MedicationRequest	—	versioned-update	Yes	Yes	No	not-supported	No	Not declared	not-supported
`AllergyIntolerance`	http://hl7.org/fhir/StructureDefinition/AllergyIntolerance	—	versioned-update	Yes	Yes	No	not-supported	No	Not declared	not-supported
`Composition`	http://hl7.org/fhir/StructureDefinition/Composition	—	versioned-update	Yes	Yes	No	not-supported	No	Not declared	not-supported
`Immunization`	http://hl7.org/fhir/StructureDefinition/Immunization	—	versioned-update	Yes	Yes	No	not-supported	No	Not declared	not-supported
`Medication`	http://hl7.org/fhir/StructureDefinition/Medication	—	versioned-update	Yes	Yes	No	not-supported	No	Not declared	not-supported
`Procedure`	http://hl7.org/fhir/StructureDefinition/Procedure	—	versioned-update	Yes	Yes	No	not-supported	No	Not declared	not-supported
`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
`DocumentReference`	http://hl7.org/fhir/StructureDefinition/DocumentReference	—	versioned-update	Yes	Yes	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
`CareTeam`	http://hl7.org/fhir/StructureDefinition/CareTeam	—	versioned-update	Yes	Yes	No	not-supported	No	Not declared	not-supported
`CarePlan`	http://hl7.org/fhir/StructureDefinition/CarePlan	—	versioned-update	Yes	Yes	No	not-supported	No	Not declared	not-supported
`FamilyMemberHistory`	http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory	—	versioned-update	Yes	Yes	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
`MedicationStatement`	http://hl7.org/fhir/StructureDefinition/MedicationStatement	—	versioned-update	Yes	Yes	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

Oracle Cloud Infrastructure Documentation

FHIR R4 Resources

Choose a Resource