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-initiator-client.json
FHIR VersionR4
Sourcehttps://build.fhir.org/ig/HL7/ode/CapabilityStatement-ode-referral-initiator-client.html
URLhttp://hl7.org/fhir/us/ode/CapabilityStatement/ode-referral-initiator-client
Version0.1.0
Statusdraft
Date2026-09-19
NameODEReferralInitiatorClient
TitleODE Referral Initiator — Client
Realmus
Authorityhl7
DescriptionA medical/dental system (or the 360X bridge on behalf of a 360X-only EHR) that creates referrals, follows Task status by referral-id, and sends/requests supporting data via CDex.
Kindrequirements

Resources that use this resource

No resources found

Resources that this resource uses

OperationDefinition
hl7.fhir.us.davinci-cdex#currentsubmit-attachmentSubmit Attachment Operation
StructureDefinition
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-medical-to-dental-referralODE Medical-to-Dental Referral
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-initiator-client

ODE Referral Initiator — Client

  • 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: client

Creates referrals (transaction Bundle), follows Task status by referral-id, and sends/requests supporting data via CDex. The 360X bridge implements this client role for a 360X-only medical EHR.

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

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 TypeProfileRSUCSearches_include_revincludeOperations
ServiceRequestSupported Profiles
  ODE Medical-to-Dental Referral
  ODE Dental-to-Dental Referral
  ODE Dental-to-Medical Referral		y
TaskSupported Profiles
  ODE Referral Task (workflow)		yyreferral-id
DocumentReference $submit-attachment

Resource Conformance: unspecified ServiceRequest

Core FHIR Resource
ServiceRequest
Reference Policy
Interaction summary
  • Supports create.

Supported Profiles

ODE Medical-to-Dental Referral
ODE Dental-to-Dental Referral
ODE Dental-to-Medical Referral

Resource Conformance: unspecified Task

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

Supported Profiles

ODE Referral Task (workflow)

Search Parameters
ConformanceParameterTypeDocumentation
SHALLreferral-idtoken
 

Resource Conformance: unspecified DocumentReference

Core FHIR Resource
DocumentReference
Reference Policy
Interaction summary

    Extended Operations
    ConformanceOperationDocumentation
    SHALL$submit-attachment

    Source1

    {
  "resourceType": "CapabilityStatement",
  "id": "ode-referral-initiator-client",
  "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-initiator-client",
  "version": "0.1.0",
  "name": "ODEReferralInitiatorClient",
  "title": "ODE Referral Initiator — Client",
  "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": "A medical/dental system (or the 360X bridge on behalf of a 360X-only EHR) that creates referrals, follows Task status by referral-id, and sends/requests supporting data via CDex.",
  "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": "client",
      "documentation": "Creates referrals (transaction Bundle), follows Task status by referral-id, and sends/requests supporting data via CDex. The 360X bridge implements this client role for a 360X-only medical EHR.",
      "security": {
        "service": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
                "code": "SMART-on-FHIR"
              }
            ]
          }
        ]
      },
      "resource": [
        {
          "type": "ServiceRequest",
          "supportedProfile": [
            "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": "create"
            }
          ]
        },
        {
          "type": "Task",
          "supportedProfile": [
            "http://hl7.org/fhir/us/ode/StructureDefinition/ode-referral-task"
          ],
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "referral-id",
              "type": "token"
            }
          ]
        },
        {
          "type": "DocumentReference",
          "operation": [
            {
              "name": "submit-attachment",
              "definition": "http://hl7.org/fhir/us/davinci-cdex/OperationDefinition/submit-attachment"
            }
          ]
        }
      ],
      "interaction": [
        {
          "code": "transaction"
        }
      ]
    }
  ]
}