FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagehl7.fhir.us.ode
Resource TypeCapabilityStatement
IdCapabilityStatement-ode-referral-recipient-server.json
FHIR VersionR4
Sourcehttps://build.fhir.org/ig/HL7/ode/CapabilityStatement-ode-referral-recipient-server.html
URLhttp://hl7.org/fhir/us/ode/CapabilityStatement/ode-referral-recipient-server
Version0.1.0
Statusdraft
Date2026-09-19
NameODEReferralRecipientServer
TitleODE Referral Recipient / Fulfiller — Server
Realmus
Authorityhl7
DescriptionThe dental ODE Native FHIR server role: accepts referral transaction Bundles, exposes the ODE workflow Task and ServiceRequest for read/search/update, and serves supporting documents/images. Also what the 360X bridge drives.
Kindrequirements

Resources that use this resource

No resources found

Resources that this resource uses

OperationDefinition
hl7.fhir.us.davinci-cdex#currentsubmit-attachmentSubmit Attachment Operation
hl7.fhir.us.ode#currentode-append-interimAppend interim clinical content to a referral
SearchParameter
hl7.fhir.us.ode#currentode-referral-idODEReferralId
StructureDefinition
hl7.fhir.us.core#currentus-core-medicationrequestUS Core MedicationRequest Profile
hl7.fhir.us.healthedata1-sandbox#currentus-core-patientUS Core Patient Profile
hl7.fhir.us.ode#currentode-dental-to-dental-referralODE Dental-to-Dental Referral
hl7.fhir.us.ode#currentode-dental-to-medical-referralODE Dental-to-Medical Referral
hl7.fhir.us.ode#currentode-diagnosticreportODE Diagnostic Report
hl7.fhir.us.ode#currentode-encounterODE Encounter
hl7.fhir.us.ode#currentode-intraoral-photo-documentreferenceODE Intraoral Photo DocumentReference (patient-submitted)
hl7.fhir.us.ode#currentode-medical-to-dental-referralODE Medical-to-Dental Referral
hl7.fhir.us.ode#currentode-medication-listODE Medication List
hl7.fhir.us.ode#currentode-observationODE Observation
hl7.fhir.us.ode#currentode-referral-documentreferenceODE Referral DocumentReference (supporting data / imaging)
hl7.fhir.us.ode#currentode-referral-servicerequestODE Referral (ServiceRequest)
hl7.fhir.us.ode#currentode-referral-taskODE Referral Task (workflow)

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement ode-referral-recipient-server

ODE Referral Recipient / Fulfiller — Server

  • Implementation Guide Version: 0.1.0
  • FHIR Version: 4.0.1
  • Supported Formats: json, xml
  • Published on: 2026-09-19
  • Published by: HL7 International / Payer/Provider Information Exchange Work Group

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: server

Accepts referral transaction Bundles, exposes the ODE workflow Task and ServiceRequest for read/search/update, and serves supporting documents/images.

Security
Enable CORS: no
Security services supported: SMART-on-FHIR
Summary of System-wide Interactions
  • Supports the transactioninteraction.
  • Supports the batchinteraction.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUPCSearches_include_revincludeOperations
TaskSupported Profiles
  ODE Referral Task (workflow)		yyyyreferral-id, status$append-interim
ServiceRequestSupported Profiles
  ODE Referral (ServiceRequest)
  ODE Medical-to-Dental Referral
  ODE Dental-to-Dental Referral
  ODE Dental-to-Medical Referral		yyreferral-id
DocumentReferenceSupported Profiles
  ODE Referral DocumentReference (supporting data / imaging)
  ODE Intraoral Photo DocumentReference (patient-submitted)		yyy$submit-attachment
PatientSupported Profiles
  US Core Patient Profileversion: 6.1.0)		yy
MedicationRequestSupported Profiles
  US Core MedicationRequest Profileversion: 6.1.0)		yypatient
ListSupported Profiles
  ODE Medication List		yy
ObservationSupported Profiles
  ODE Observation		yyy
DiagnosticReportSupported Profiles
  ODE Diagnostic Report		yyy
EncounterSupported Profiles
  ODE Encounter		yyy

Resource Conformance: unspecified Task

Core FHIR Resource
Task
Reference Policy
Interaction summary
  • Supports read, search-type, update, patch.

Supported Profiles

ODE Referral Task (workflow)

Search Parameters
ConformanceParameterTypeDocumentation
SHALLreferral-idtoken
SHALLstatustoken
 
Extended Operations
ConformanceOperationDocumentation
SHALL$append-interim

Attach interim clinical content (Encounter, DiagnosticReport, Observation) to an open referral: creates the resources, attaches them to Task.output, and advances businessStatus (typically to interim-results). The ODE-native equivalent of a 360X PCC-59 Interim Consultation Note — usable with no bridge.

Resource Conformance: unspecified ServiceRequest

Core FHIR Resource
ServiceRequest
Reference Policy
Interaction summary
  • Supports read, search-type.

Supported Profiles

ODE Referral (ServiceRequest)
ODE Medical-to-Dental Referral
ODE Dental-to-Dental Referral
ODE Dental-to-Medical Referral

Search Parameters
ConformanceParameterTypeDocumentation
SHALLreferral-idtoken
 

Resource Conformance: unspecified DocumentReference

Core FHIR Resource
DocumentReference
Reference Policy
Interaction summary
  • Supports read, search-type, create.

Supported Profiles

ODE Referral DocumentReference (supporting data / imaging)
ODE Intraoral Photo DocumentReference (patient-submitted)

Extended Operations
ConformanceOperationDocumentation
SHALL$submit-attachment

Da Vinci CDex $submit-attachment — the separate-push imaging path used whenever the receiver is on the medical side (medical->dental, dental->medical). Dental->dental instead uses a pull (GET /DocumentReference/{id}).

Resource Conformance: unspecified Patient

Core FHIR Resource
Patient
Reference Policy
Interaction summary
  • Supports read, search-type.

Supported Profiles

US Core Patient Profileversion: 6.1.0)

Resource Conformance: unspecified MedicationRequest

Core FHIR Resource
MedicationRequest
Reference Policy
Interaction summary
  • Supports read, search-type.

Supported Profiles

US Core MedicationRequest Profileversion: 6.1.0)

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
 

Resource Conformance: unspecified List

Core FHIR Resource
List
Reference Policy
Interaction summary
  • Supports read, search-type.

Supported Profiles

ODE Medication List

Resource Conformance: unspecified Observation

Core FHIR Resource
Observation
Reference Policy
Interaction summary
  • Supports create, read, search-type.

Supported Profiles

ODE Observation

Resource Conformance: unspecified DiagnosticReport

Core FHIR Resource
DiagnosticReport
Reference Policy
Interaction summary
  • Supports create, read, search-type.

Supported Profiles

ODE Diagnostic Report

Resource Conformance: unspecified Encounter

Core FHIR Resource
Encounter
Reference Policy
Interaction summary
  • Supports create, read, search-type.

Supported Profiles

ODE Encounter

Source1

{
  "resourceType": "CapabilityStatement",
  "id": "ode-referral-recipient-server",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "claims"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 0,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/us/ode/ImplementationGuide/hl7.fhir.us.ode"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "draft",
      "_valueCode": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/us/ode/ImplementationGuide/hl7.fhir.us.ode"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/us/ode/CapabilityStatement/ode-referral-recipient-server",
  "version": "0.1.0",
  "name": "ODEReferralRecipientServer",
  "title": "ODE Referral Recipient / Fulfiller — Server",
  "status": "draft",
  "date": "2026-09-19",
  "publisher": "HL7 International / Payer/Provider Information Exchange Work Group",
  "contact": [
    {
      "name": "HL7 International / Payer/Provider Information Exchange Work Group",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/claims"
        },
        {
          "system": "email",
          "value": "pie@lists.hl7.org"
        }
      ]
    },
    {
      "name": "Mark Marciante",
      "telecom": [
        {
          "system": "email",
          "value": "mark.marciante@leavittpartners.com",
          "use": "work"
        }
      ]
    }
  ],
  "description": "The dental ODE Native FHIR server role: accepts referral transaction Bundles, exposes the ODE workflow Task and ServiceRequest for read/search/update, and serves supporting documents/images. Also what the 360X bridge drives.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "US",
          "display": "United States of America"
        }
      ]
    }
  ],
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "json",
    "xml"
  ],
  "rest": [
    {
      "mode": "server",
      "documentation": "Accepts referral transaction Bundles, exposes the ODE workflow Task and ServiceRequest for read/search/update, and serves supporting documents/images.",
      "security": {
        "service": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
                "code": "SMART-on-FHIR"
              }
            ]
          }
        ]
      },
      "resource": [
        {
          "type": "Task",
          "supportedProfile": [
            "http://hl7.org/fhir/us/ode/StructureDefinition/ode-referral-task"
          ],
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            },
            {
              "code": "update"
            },
            {
              "code": "patch"
            }
          ],
          "searchParam": [
            {
              "name": "referral-id",
              "definition": "http://hl7.org/fhir/us/ode/SearchParameter/ode-referral-id",
              "type": "token"
            },
            {
              "name": "status",
              "type": "token"
            }
          ],
          "operation": [
            {
              "name": "append-interim",
              "definition": "http://hl7.org/fhir/us/ode/OperationDefinition/ode-append-interim",
              "documentation": "Attach interim clinical content (Encounter, DiagnosticReport, Observation) to an open referral: creates the resources, attaches them to Task.output, and advances businessStatus (typically to interim-results). The ODE-native equivalent of a 360X PCC-59 Interim Consultation Note — usable with no bridge."
            }
          ]
        },
        {
          "type": "ServiceRequest",
          "supportedProfile": [
            "http://hl7.org/fhir/us/ode/StructureDefinition/ode-referral-servicerequest",
            "http://hl7.org/fhir/us/ode/StructureDefinition/ode-medical-to-dental-referral",
            "http://hl7.org/fhir/us/ode/StructureDefinition/ode-dental-to-dental-referral",
            "http://hl7.org/fhir/us/ode/StructureDefinition/ode-dental-to-medical-referral"
          ],
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "referral-id",
              "type": "token"
            }
          ]
        },
        {
          "type": "DocumentReference",
          "supportedProfile": [
            "http://hl7.org/fhir/us/ode/StructureDefinition/ode-referral-documentreference",
            "http://hl7.org/fhir/us/ode/StructureDefinition/ode-intraoral-photo-documentreference"
          ],
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            },
            {
              "code": "create"
            }
          ],
          "operation": [
            {
              "name": "submit-attachment",
              "definition": "http://hl7.org/fhir/us/davinci-cdex/OperationDefinition/submit-attachment",
              "documentation": "Da Vinci CDex $submit-attachment — the separate-push imaging path used whenever the receiver is on the medical side (medical->dental, dental->medical). Dental->dental instead uses a pull (GET /DocumentReference/{id})."
            }
          ]
        },
        {
          "type": "Patient",
          "supportedProfile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient|6.1.0"
          ],
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ]
        },
        {
          "type": "MedicationRequest",
          "supportedProfile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest|6.1.0"
          ],
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "patient",
              "type": "reference"
            }
          ]
        },
        {
          "type": "List",
          "supportedProfile": [
            "http://hl7.org/fhir/us/ode/StructureDefinition/ode-medication-list"
          ],
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ]
        },
        {
          "type": "Observation",
          "supportedProfile": [
            "http://hl7.org/fhir/us/ode/StructureDefinition/ode-observation"
          ],
          "interaction": [
            {
              "code": "create"
            },
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ]
        },
        {
          "type": "DiagnosticReport",
          "supportedProfile": [
            "http://hl7.org/fhir/us/ode/StructureDefinition/ode-diagnosticreport"
          ],
          "interaction": [
            {
              "code": "create"
            },
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ]
        },
        {
          "type": "Encounter",
          "supportedProfile": [
            "http://hl7.org/fhir/us/ode/StructureDefinition/ode-encounter"
          ],
          "interaction": [
            {
              "code": "create"
            },
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ]
        }
      ],
      "interaction": [
        {
          "code": "transaction"
        },
        {
          "code": "batch"
        }
      ]
    }
  ]
}