FHIR Endpoints

R4 Endpoints

For resource-specific operation references and success codes, see FHIR R4 endpoints.

GET /api/fhir/r4/Condition
POST /api/fhir/r4/Condition
POST /api/fhir/r4/Condition/$purgeDeleted
GET /api/fhir/r4/Condition/{rid}
PUT /api/fhir/r4/Condition/{rid}
DELETE /api/fhir/r4/Condition/{rid}
POST /api/fhir/r4/Condition/{rid}/$hardDelete
GET /api/fhir/r4/Condition/{rid}/_history/{vid}
GET /api/fhir/r4/Device
POST /api/fhir/r4/Device
POST /api/fhir/r4/Device/$purgeDeleted
GET /api/fhir/r4/Device/{rid}
PUT /api/fhir/r4/Device/{rid}
DELETE /api/fhir/r4/Device/{rid}
POST /api/fhir/r4/Device/{rid}/$hardDelete
GET /api/fhir/r4/Device/{rid}/_history/{vid}
# DocumentReference (FHIR R4 only)
GET /api/fhir/r4/DocumentReference
POST /api/fhir/r4/DocumentReference
POST /api/fhir/r4/DocumentReference/_search
GET /api/fhir/r4/DocumentReference/{rid}
GET /api/fhir/r4/DocumentReference/{rid}/_history/{vid}
PUT /api/fhir/r4/DocumentReference/{rid}
DELETE /api/fhir/r4/DocumentReference/{rid}
POST /api/fhir/r4/DocumentReference/{rid}/$hardDelete
POST /api/fhir/r4/DocumentReference/$purgeDeleted

GET /api/fhir/r4/DiagnosticReport
POST /api/fhir/r4/DiagnosticReport
POST /api/fhir/r4/DiagnosticReport/$purgeDeleted
GET /api/fhir/r4/DiagnosticReport/{rid}
PUT /api/fhir/r4/DiagnosticReport/{rid}
DELETE /api/fhir/r4/DiagnosticReport/{rid}
POST /api/fhir/r4/DiagnosticReport/{rid}/$hardDelete
GET /api/fhir/r4/DiagnosticReport/{rid}/_history/{vid}
GET /api/fhir/r4/Encounter
POST /api/fhir/r4/Encounter
POST /api/fhir/r4/Encounter/$purgeDeleted
GET /api/fhir/r4/Encounter/{rid}
PUT /api/fhir/r4/Encounter/{rid}
DELETE /api/fhir/r4/Encounter/{rid}
POST /api/fhir/r4/Encounter/{rid}/$hardDelete
GET /api/fhir/r4/Encounter/{rid}/_history/{vid}
GET /api/fhir/r4/Endpoint
POST /api/fhir/r4/Endpoint
POST /api/fhir/r4/Endpoint/$purgeDeleted
GET /api/fhir/r4/Endpoint/{rid}
PUT /api/fhir/r4/Endpoint/{rid}
DELETE /api/fhir/r4/Endpoint/{rid}
POST /api/fhir/r4/Endpoint/{rid}/$hardDelete
GET /api/fhir/r4/Endpoint/{rid}/_history/{vid}
GET /api/fhir/r4/Group
POST /api/fhir/r4/Group
POST /api/fhir/r4/Group/$purgeDeleted
GET /api/fhir/r4/Group/{rid}
PUT /api/fhir/r4/Group/{rid}
DELETE /api/fhir/r4/Group/{rid}
POST /api/fhir/r4/Group/{rid}/$hardDelete
GET /api/fhir/r4/Group/{rid}/_history/{vid}
GET /api/fhir/r4/Location
POST /api/fhir/r4/Location
POST /api/fhir/r4/Location/$purgeDeleted
GET /api/fhir/r4/Location/{rid}
PUT /api/fhir/r4/Location/{rid}
DELETE /api/fhir/r4/Location/{rid}
POST /api/fhir/r4/Location/{rid}/$hardDelete
GET /api/fhir/r4/Location/{rid}/_history/{vid}
GET /api/fhir/r4/Observation
POST /api/fhir/r4/Observation
POST /api/fhir/r4/Observation/$purgeDeleted
GET /api/fhir/r4/Observation/{rid}
PUT /api/fhir/r4/Observation/{rid}
DELETE /api/fhir/r4/Observation/{rid}
POST /api/fhir/r4/Observation/{rid}/$hardDelete
GET /api/fhir/r4/Observation/{rid}/_history/{vid}
GET /api/fhir/r4/Organization
POST /api/fhir/r4/Organization
POST /api/fhir/r4/Organization/$purgeDeleted
GET /api/fhir/r4/Organization/{rid}
PUT /api/fhir/r4/Organization/{rid}
DELETE /api/fhir/r4/Organization/{rid}
POST /api/fhir/r4/Organization/{rid}/$hardDelete
GET /api/fhir/r4/Organization/{rid}/_history/{vid}
GET /api/fhir/r4/Patient
POST /api/fhir/r4/Patient
POST /api/fhir/r4/Patient/$purgeDeleted
GET /api/fhir/r4/Patient/{rid}
PUT /api/fhir/r4/Patient/{rid}
DELETE /api/fhir/r4/Patient/{rid}
POST /api/fhir/r4/Patient/{rid}/$hardDelete
GET /api/fhir/r4/Patient/{rid}/_history/{vid}
GET /api/fhir/r4/Practitioner
POST /api/fhir/r4/Practitioner
POST /api/fhir/r4/Practitioner/$purgeDeleted
GET /api/fhir/r4/Practitioner/{rid}
PUT /api/fhir/r4/Practitioner/{rid}
DELETE /api/fhir/r4/Practitioner/{rid}
POST /api/fhir/r4/Practitioner/{rid}/$hardDelete
GET /api/fhir/r4/Practitioner/{rid}/_history/{vid}
GET /api/fhir/r4/PractitionerRole
POST /api/fhir/r4/PractitionerRole
POST /api/fhir/r4/PractitionerRole/$purgeDeleted
GET /api/fhir/r4/PractitionerRole/{rid}
PUT /api/fhir/r4/PractitionerRole/{rid}
DELETE /api/fhir/r4/PractitionerRole/{rid}
POST /api/fhir/r4/PractitionerRole/{rid}/$hardDelete
GET /api/fhir/r4/PractitionerRole/{rid}/_history/{vid}
GET /api/fhir/r4/Provenance
POST /api/fhir/r4/Provenance
POST /api/fhir/r4/Provenance/$purgeDeleted
GET /api/fhir/r4/Provenance/{rid}
PUT /api/fhir/r4/Provenance/{rid}
DELETE /api/fhir/r4/Provenance/{rid}
POST /api/fhir/r4/Provenance/{rid}/$hardDelete
GET /api/fhir/r4/Provenance/{rid}/_history/{vid}
GET /api/fhir/r4/RelatedPerson
POST /api/fhir/r4/RelatedPerson
POST /api/fhir/r4/RelatedPerson/$purgeDeleted
GET /api/fhir/r4/RelatedPerson/{rid}
PUT /api/fhir/r4/RelatedPerson/{rid}
DELETE /api/fhir/r4/RelatedPerson/{rid}
POST /api/fhir/r4/RelatedPerson/{rid}/$hardDelete
GET /api/fhir/r4/RelatedPerson/{rid}/_history/{vid}
GET /api/fhir/r4/ServiceRequest
POST /api/fhir/r4/ServiceRequest
POST /api/fhir/r4/ServiceRequest/$purgeDeleted
GET /api/fhir/r4/ServiceRequest/{rid}
PUT /api/fhir/r4/ServiceRequest/{rid}
DELETE /api/fhir/r4/ServiceRequest/{rid}
POST /api/fhir/r4/ServiceRequest/{rid}/$hardDelete
GET /api/fhir/r4/ServiceRequest/{rid}/_history/{vid}
GET /api/fhir/r4/Specimen
POST /api/fhir/r4/Specimen
POST /api/fhir/r4/Specimen/$purgeDeleted
GET /api/fhir/r4/Specimen/{rid}
PUT /api/fhir/r4/Specimen/{rid}
DELETE /api/fhir/r4/Specimen/{rid}
POST /api/fhir/r4/Specimen/{rid}/$hardDelete
GET /api/fhir/r4/Specimen/{rid}/_history/{vid}
        

Additional R4 Resource Endpoints

For request content, authorization, search restrictions and response details, see AllergyIntolerance, CarePlan, CareTeam, Composition, FamilyMemberHistory, Immunization, Medication, MedicationRequest, MedicationStatement, Procedure. Check the deployed R4 CapabilityStatement before using these endpoints.

# AllergyIntolerance (FHIR R4)
GET /api/fhir/r4/AllergyIntolerance
POST /api/fhir/r4/AllergyIntolerance
POST /api/fhir/r4/AllergyIntolerance/_search
GET /api/fhir/r4/AllergyIntolerance/{rid}
GET /api/fhir/r4/AllergyIntolerance/{rid}/_history/{vid}
PUT /api/fhir/r4/AllergyIntolerance/{rid}
DELETE /api/fhir/r4/AllergyIntolerance/{rid}
POST /api/fhir/r4/AllergyIntolerance/{rid}/$hardDelete
POST /api/fhir/r4/AllergyIntolerance/$purgeDeleted

# CarePlan (FHIR R4)
GET /api/fhir/r4/CarePlan
POST /api/fhir/r4/CarePlan
POST /api/fhir/r4/CarePlan/_search
GET /api/fhir/r4/CarePlan/{rid}
GET /api/fhir/r4/CarePlan/{rid}/_history/{vid}
PUT /api/fhir/r4/CarePlan/{rid}
DELETE /api/fhir/r4/CarePlan/{rid}
POST /api/fhir/r4/CarePlan/{rid}/$hardDelete
POST /api/fhir/r4/CarePlan/$purgeDeleted

# CareTeam (FHIR R4)
GET /api/fhir/r4/CareTeam
POST /api/fhir/r4/CareTeam
POST /api/fhir/r4/CareTeam/_search
GET /api/fhir/r4/CareTeam/{rid}
GET /api/fhir/r4/CareTeam/{rid}/_history/{vid}
PUT /api/fhir/r4/CareTeam/{rid}
DELETE /api/fhir/r4/CareTeam/{rid}
POST /api/fhir/r4/CareTeam/{rid}/$hardDelete
POST /api/fhir/r4/CareTeam/$purgeDeleted

# Composition (FHIR R4)
GET /api/fhir/r4/Composition
POST /api/fhir/r4/Composition
POST /api/fhir/r4/Composition/_search
GET /api/fhir/r4/Composition/{rid}
GET /api/fhir/r4/Composition/{rid}/_history/{vid}
PUT /api/fhir/r4/Composition/{rid}
DELETE /api/fhir/r4/Composition/{rid}
POST /api/fhir/r4/Composition/{rid}/$hardDelete
POST /api/fhir/r4/Composition/$purgeDeleted

# FamilyMemberHistory (FHIR R4)
GET /api/fhir/r4/FamilyMemberHistory
POST /api/fhir/r4/FamilyMemberHistory
POST /api/fhir/r4/FamilyMemberHistory/_search
GET /api/fhir/r4/FamilyMemberHistory/{rid}
GET /api/fhir/r4/FamilyMemberHistory/{rid}/_history/{vid}
PUT /api/fhir/r4/FamilyMemberHistory/{rid}
DELETE /api/fhir/r4/FamilyMemberHistory/{rid}
POST /api/fhir/r4/FamilyMemberHistory/{rid}/$hardDelete
POST /api/fhir/r4/FamilyMemberHistory/$purgeDeleted

# Immunization (FHIR R4)
GET /api/fhir/r4/Immunization
POST /api/fhir/r4/Immunization
POST /api/fhir/r4/Immunization/_search
GET /api/fhir/r4/Immunization/{rid}
GET /api/fhir/r4/Immunization/{rid}/_history/{vid}
PUT /api/fhir/r4/Immunization/{rid}
DELETE /api/fhir/r4/Immunization/{rid}
POST /api/fhir/r4/Immunization/{rid}/$hardDelete
POST /api/fhir/r4/Immunization/$purgeDeleted

# Medication (FHIR R4)
GET /api/fhir/r4/Medication
POST /api/fhir/r4/Medication
POST /api/fhir/r4/Medication/_search
GET /api/fhir/r4/Medication/{rid}
GET /api/fhir/r4/Medication/{rid}/_history/{vid}
PUT /api/fhir/r4/Medication/{rid}
DELETE /api/fhir/r4/Medication/{rid}
POST /api/fhir/r4/Medication/{rid}/$hardDelete
POST /api/fhir/r4/Medication/$purgeDeleted

# MedicationRequest (FHIR R4)
GET /api/fhir/r4/MedicationRequest
POST /api/fhir/r4/MedicationRequest
POST /api/fhir/r4/MedicationRequest/_search
GET /api/fhir/r4/MedicationRequest/{rid}
GET /api/fhir/r4/MedicationRequest/{rid}/_history/{vid}
PUT /api/fhir/r4/MedicationRequest/{rid}
DELETE /api/fhir/r4/MedicationRequest/{rid}
POST /api/fhir/r4/MedicationRequest/{rid}/$hardDelete
POST /api/fhir/r4/MedicationRequest/$purgeDeleted

# MedicationStatement (FHIR R4)
GET /api/fhir/r4/MedicationStatement
POST /api/fhir/r4/MedicationStatement
POST /api/fhir/r4/MedicationStatement/_search
GET /api/fhir/r4/MedicationStatement/{rid}
GET /api/fhir/r4/MedicationStatement/{rid}/_history/{vid}
PUT /api/fhir/r4/MedicationStatement/{rid}
DELETE /api/fhir/r4/MedicationStatement/{rid}
POST /api/fhir/r4/MedicationStatement/{rid}/$hardDelete
POST /api/fhir/r4/MedicationStatement/$purgeDeleted

# Procedure (FHIR R4)
GET /api/fhir/r4/Procedure
POST /api/fhir/r4/Procedure
POST /api/fhir/r4/Procedure/_search
GET /api/fhir/r4/Procedure/{rid}
GET /api/fhir/r4/Procedure/{rid}/_history/{vid}
PUT /api/fhir/r4/Procedure/{rid}
DELETE /api/fhir/r4/Procedure/{rid}
POST /api/fhir/r4/Procedure/{rid}/$hardDelete
POST /api/fhir/r4/Procedure/$purgeDeleted

R6 Endpoints

GET /api/fhir/r6-ballot4/Device
POST /api/fhir/r6-ballot4/Device
POST /api/fhir/r6-ballot4/Device/$purgeDeleted
GET /api/fhir/r6-ballot4/Device/{rid}
PUT /api/fhir/r6-ballot4/Device/{rid}
DELETE /api/fhir/r6-ballot4/Device/{rid}
POST /api/fhir/r6-ballot4/Device/{rid}/$hardDelete
GET /api/fhir/r6-ballot4/Device/{rid}/_history/{vid}
GET /api/fhir/r6-ballot4/DeviceAssociation
POST /api/fhir/r6-ballot4/DeviceAssociation
POST /api/fhir/r6-ballot4/DeviceAssociation/$purgeDeleted
GET /api/fhir/r6-ballot4/DeviceAssociation/{rid}
PUT /api/fhir/r6-ballot4/DeviceAssociation/{rid}
DELETE /api/fhir/r6-ballot4/DeviceAssociation/{rid}
POST /api/fhir/r6-ballot4/DeviceAssociation/{rid}/$hardDelete
GET /api/fhir/r6-ballot4/DeviceAssociation/{rid}/_history/{vid}
GET /api/fhir/r6-ballot4/Encounter
POST /api/fhir/r6-ballot4/Encounter
POST /api/fhir/r6-ballot4/Encounter/$purgeDeleted
GET /api/fhir/r6-ballot4/Encounter/{rid}
PUT /api/fhir/r6-ballot4/Encounter/{rid}
DELETE /api/fhir/r6-ballot4/Encounter/{rid}
POST /api/fhir/r6-ballot4/Encounter/{rid}/$hardDelete
GET /api/fhir/r6-ballot4/Encounter/{rid}/_history/{vid}
GET /api/fhir/r6-ballot4/Location
POST /api/fhir/r6-ballot4/Location
POST /api/fhir/r6-ballot4/Location/$purgeDeleted
GET /api/fhir/r6-ballot4/Location/{rid}
PUT /api/fhir/r6-ballot4/Location/{rid}
DELETE /api/fhir/r6-ballot4/Location/{rid}
POST /api/fhir/r6-ballot4/Location/{rid}/$hardDelete
GET /api/fhir/r6-ballot4/Location/{rid}/_history/{vid}
GET /api/fhir/r6-ballot4/Observation
POST /api/fhir/r6-ballot4/Observation
POST /api/fhir/r6-ballot4/Observation/$purgeDeleted
GET /api/fhir/r6-ballot4/Observation/{rid}
PUT /api/fhir/r6-ballot4/Observation/{rid}
DELETE /api/fhir/r6-ballot4/Observation/{rid}
POST /api/fhir/r6-ballot4/Observation/{rid}/$hardDelete
GET /api/fhir/r6-ballot4/Observation/{rid}/_history/{vid}
GET /api/fhir/r6-ballot4/Patient
POST /api/fhir/r6-ballot4/Patient
POST /api/fhir/r6-ballot4/Patient/$purgeDeleted
GET /api/fhir/r6-ballot4/Patient/{rid}
PUT /api/fhir/r6-ballot4/Patient/{rid}
DELETE /api/fhir/r6-ballot4/Patient/{rid}
POST /api/fhir/r6-ballot4/Patient/{rid}/$hardDelete
GET /api/fhir/r6-ballot4/Patient/{rid}/_history/{vid}
GET /api/fhir/r6-ballot4/Practitioner
POST /api/fhir/r6-ballot4/Practitioner
POST /api/fhir/r6-ballot4/Practitioner/$purgeDeleted
GET /api/fhir/r6-ballot4/Practitioner/{rid}
PUT /api/fhir/r6-ballot4/Practitioner/{rid}
DELETE /api/fhir/r6-ballot4/Practitioner/{rid}
POST /api/fhir/r6-ballot4/Practitioner/{rid}/$hardDelete
GET /api/fhir/r6-ballot4/Practitioner/{rid}/_history/{vid}
GET /api/fhir/r6-ballot4/PractitionerRole
POST /api/fhir/r6-ballot4/PractitionerRole
POST /api/fhir/r6-ballot4/PractitionerRole/$purgeDeleted
GET /api/fhir/r6-ballot4/PractitionerRole/{rid}
PUT /api/fhir/r6-ballot4/PractitionerRole/{rid}
DELETE /api/fhir/r6-ballot4/PractitionerRole/{rid}
POST /api/fhir/r6-ballot4/PractitionerRole/{rid}/$hardDelete
GET /api/fhir/r6-ballot4/PractitionerRole/{rid}/_history/{vid}
GET /api/fhir/r6-ballot4/Provenance
POST /api/fhir/r6-ballot4/Provenance
POST /api/fhir/r6-ballot4/Provenance/$purgeDeleted
GET /api/fhir/r6-ballot4/Provenance/{rid}
PUT /api/fhir/r6-ballot4/Provenance/{rid}
DELETE /api/fhir/r6-ballot4/Provenance/{rid}
POST /api/fhir/r6-ballot4/Provenance/{rid}/$hardDelete
GET /api/fhir/r6-ballot4/Provenance/{rid}/_history/{vid}
GET /api/fhir/r6-ballot4/Subscription
POST /api/fhir/r6-ballot4/Subscription
POST /api/fhir/r6-ballot4/Subscription/$purgeDeleted
GET /api/fhir/r6-ballot4/Subscription/$status
GET /api/fhir/r6-ballot4/Subscription/{rid}
PUT /api/fhir/r6-ballot4/Subscription/{rid}
DELETE /api/fhir/r6-ballot4/Subscription/{rid}
POST /api/fhir/r6-ballot4/Subscription/{rid}/$hardDelete
GET /api/fhir/r6-ballot4/Subscription/{rid}/$status
GET /api/fhir/r6-ballot4/Subscription/{rid}/_history/{vid}
GET /api/fhir/r6-ballot4/SubscriptionTopic
POST /api/fhir/r6-ballot4/SubscriptionTopic
POST /api/fhir/r6-ballot4/SubscriptionTopic/$purgeDeleted
GET /api/fhir/r6-ballot4/SubscriptionTopic/{rid}
PUT /api/fhir/r6-ballot4/SubscriptionTopic/{rid}
DELETE /api/fhir/r6-ballot4/SubscriptionTopic/{rid}
POST /api/fhir/r6-ballot4/SubscriptionTopic/{rid}/$hardDelete
GET /api/fhir/r6-ballot4/SubscriptionTopic/{rid}/_history/{vid}
        

See also

For permanent deletion guidance, see Data deletion and purge operations.

Status Codes