Ballerina library

health.fhir.r4.davincipdex220

Module health.fhir.r4.davincipdex220

Usage

API

initialize

Declarations

PROFILE_BASE_PDEXMULTIMEMBERMATCHREQUESTPARAMETERS
PROFILE_BASE_PDEXMULTIMEMBERMATCHRESPONSEPARAMETERS
RESOURCE_NAME_PDEXMULTIMEMBERMATCHREQUESTPARAMETERS
RESOURCE_NAME_PDEXMULTIMEMBERMATCHRESPONSEPARAMETERS

terminologyProcessor
fhirRegistry
FHIR_VALUE_SETS
FHIR_CODE_SYSTEMS

Definitions

BulkMemberMatchResources
BulkMemberMatchResult
DataExportJob
DataExportParameters
PDexMultiMemberMatchRequestParameters
PDexMultiMemberMatchRequestParametersParameter
PDexMultiMemberMatchRequestParametersParameterMemberBundle
PDexMultiMemberMatchResponseParameters
PDexMultiMemberMatchResponseParametersParameter
PDexMultiMemberMatchResponseParametersParameterConsentConstrainedMembers
PDexMultiMemberMatchResponseParametersParameterMatchedMembers
PDexMultiMemberMatchResponseParametersParameterNonMatchedMembers

BulkMemberMatcherDaVinciDataExporter

ballerinax/health.fhir.r4.davincipdex220 Ballerina library

1.0.0
Da Vinci Payer Data Exchange (PDex) FHIR R4 Module

This module provides support for the Da Vinci Payer Data Exchange (PDex) Implementation Guide v2.2.0.

It includes:

  • $bulk-member-match – Type-level operation on Group ([base]/Group/$bulk-member-match). Enables payers to match multiple members against another payer's records in bulk. Defined in the PDex IG.
  • $davinci-data-export – Instance-level operation on Group ([base]/Group/[id]/$davinci-data-export). Exports payer member health data asynchronously. Defined in the Da Vinci ATR IG (used in PDex payer-to-payer exchange).

Usage

Implement the BulkMemberMatcher object type to handle $bulk-member-match requests:

Copy
public isolated class MyBulkMatcher {
    *davincipdex220:BulkMemberMatcher;

    public isolated function matchMembers(davincipdex220:BulkMemberMatchResources resources)
            returns davincipdex220:BulkMemberMatchResult|r4:FHIRError {
        // Custom matching logic
    }
}

Implement DaVinciDataExporter to handle $davinci-data-export requests:

Copy
public isolated class MyDataExporter {
    *davincipdex220:DaVinciDataExporter;

    public isolated function initiateExport(string? groupId, davincipdex220:DataExportParameters params)
            returns davincipdex220:DataExportJob|r4:FHIRError {
        // Initiate async bulk export and return polling URL
    }
}

Functions

initialize

Isolated Function
function initialize()

This empty function is used to initialize the module by other modules/packages.

Constants

health.fhir.r4.davincipdex220: PROFILE_BASE_PDEXMULTIMEMBERMATCHREQUESTPARAMETERS

string "http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-parameters-multi-member-match-bundle-in"

health.fhir.r4.davincipdex220: PROFILE_BASE_PDEXMULTIMEMBERMATCHRESPONSEPARAMETERS

string "http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-parameters-multi-member-match-bundle-out"

health.fhir.r4.davincipdex220: RESOURCE_NAME_PDEXMULTIMEMBERMATCHREQUESTPARAMETERS

string "Parameters"

health.fhir.r4.davincipdex220: RESOURCE_NAME_PDEXMULTIMEMBERMATCHRESPONSEPARAMETERS

string "Parameters"

Variables

health.fhir.r4.davincipdex220: terminologyProcessor

TerminologyProcessor(default r4:terminologyProcessor)

Terminology processor instance

health.fhir.r4.davincipdex220: fhirRegistry

FHIRRegistry(default r4:fhirRegistry)

FHIR registry instance

health.fhir.r4.davincipdex220: FHIR_VALUE_SETS

json[](default [])

health.fhir.r4.davincipdex220: FHIR_CODE_SYSTEMS

json[](default [])

Records

health.fhir.r4.davincipdex220: BulkMemberMatchResources

Closed record

Holds the input for a $bulk-member-match operation.

Fields
  • requestParameters PDexMultiMemberMatchRequestParameters - A PDexMultiMemberMatchRequestParameters resource containing one or more MemberBundle parameters. Each bundle provides the demographics, coverage, and consent data for a single member to be matched.

health.fhir.r4.davincipdex220: BulkMemberMatchResult

Closed record

Holds the output of a $bulk-member-match operation.

Fields
  • responseParameters PDexMultiMemberMatchResponseParameters - A PDexMultiMemberMatchResponseParameters resource containing:
    • MatchedMembers (1..1): Group of successfully matched members (PDexMemberMatchGroup)
    • NonMatchedMembers (0..1): Group of unmatched members (PDexMemberNoMatchGroup)
    • ConsentConstrainedMembers (0..1): Group excluded due to consent (PDexMemberNoMatchGroup)

health.fhir.r4.davincipdex220: DataExportJob

Closed record

Represents an asynchronous export job initiated by $davinci-data-export. Implementors return this to indicate the export has been accepted for processing.

Fields
  • contentLocation string - URL for polling the export status. Returned as the Content-Location HTTP response header (per FHIR Async Request Pattern).
  • statusCode int(default 202) - HTTP status code for the initial kick-off response. Defaults to 202 Accepted.

health.fhir.r4.davincipdex220: DataExportParameters

Closed record

Parameters for the $davinci-data-export operation. All fields are optional per the Da Vinci ATR IG specification. The operation is instance-level on Group: POST [base]/Group/[id]/$davinci-data-export

Fields
  • patient? Reference[] - References to specific members whose data should be exported. When omitted, data for all members in the Group is exported.
  • exportType? string - Canonical URL identifying the export type / use case. In the PDex payer-to-payer context use hl7.fhir.us.davinci-pdex#payertopayer.
  • _since? string - Resources updated after this instant will be included. Format: FHIR instant (e.g., 2024-01-01T00:00:00Z). Claims and clinical data are limited to records within the past 5 years.
  • _until? string - Resources updated before this instant will be included. Format: FHIR instant.
  • _type? string - Comma-delimited list of FHIR resource types to include. When omitted, all supported resource types are exported.
  • _typeFilter? string - Comma-delimited list of FHIR search queries to restrict exported resources.

health.fhir.r4.davincipdex220: PDexMultiMemberMatchRequestParameters

FHIR PDexMultiMemberMatchRequestParameters resource record.

Defines the inputs to a $bulk-member-match operation performed by a payer system. (Canonical: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-parameters-multi-member-match-bundle-in)

Fields
  • meta? Meta - The metadata about the resource.
  • 'parameter PDexMultiMemberMatchRequestParametersParameter[] - Repeating MemberBundle parameter (1..*). Each MemberBundle groups one member's match data using parts:
    • parameter Slicings
    1. PDexMultiMemberMatchRequestParametersParameterMemberBundle: MemberBundle parameter
    • min = 1
    • max = *
  • implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed.
  • language? code - The base language in which the resource is written.
  • id? string - The logical id of the resource.
  • Element... - Rest field

health.fhir.r4.davincipdex220: PDexMultiMemberMatchRequestParametersParameter

Closed record

FHIR PDexMultiMemberMatchRequestParametersParameter datatype record.

Base type for a parameter entry in the multi-member-match request.

Fields
  • modifierExtension? Extension[] - Modifier extensions.
  • part? ParametersParameter[] - Named parts of the parameter (MemberPatient, CoverageToMatch, Consent, CoverageToLink).
  • name string - The name of the parameter.
  • id? string - Unique id for the element within a resource.

health.fhir.r4.davincipdex220: PDexMultiMemberMatchRequestParametersParameterMemberBundle

Closed record

FHIR PDexMultiMemberMatchRequestParametersParameterMemberBundle datatype record.

Represents a single member's match data bundle as a named parameter "MemberBundle". Parts: MemberPatient (1..1), CoverageToMatch (1..1), Consent (1..1), CoverageToLink (0..1).

Fields
  • modifierExtension? Extension[] - Modifier extensions.
  • name string(default "MemberBundle") - Fixed value "MemberBundle".
  • id? string - Unique id for the element within a resource.

health.fhir.r4.davincipdex220: PDexMultiMemberMatchResponseParameters

FHIR PDexMultiMemberMatchResponseParameters resource record.

Defines the output of a $bulk-member-match operation. (Canonical: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-parameters-multi-member-match-bundle-out)

Fields
  • meta? Meta - The metadata about the resource.
  • 'parameter PDexMultiMemberMatchResponseParametersParameter[] - Operation output parameters (1..3), closed slicing by name:
    • parameter Slicings
    1. PDexMultiMemberMatchResponseParametersParameterMatchedMembers (1..1)
    2. PDexMultiMemberMatchResponseParametersParameterNonMatchedMembers (0..1)
    3. PDexMultiMemberMatchResponseParametersParameterConsentConstrainedMembers (0..1)
  • implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed.
  • language? code - The base language in which the resource is written.
  • id? string - The logical id of the resource.
  • Element... - Rest field

health.fhir.r4.davincipdex220: PDexMultiMemberMatchResponseParametersParameter

Closed record

FHIR PDexMultiMemberMatchResponseParametersParameter datatype record.

Base type for a response parameter entry.

Fields
  • modifierExtension? Extension[] - Modifier extensions.
  • 'resource? Resource - Group resource holding matched or unmatched members.
  • name string - The name of the parameter.
  • id? string - Unique id for the element within a resource.

health.fhir.r4.davincipdex220: PDexMultiMemberMatchResponseParametersParameterConsentConstrainedMembers

Closed record

Slice: ConsentConstrainedMembers (0..1) — PDexMemberNoMatchGroup.

Fields
  • modifierExtension? Extension[] - Modifier extensions.
  • 'resource Resource - Group resource (PDexMemberNoMatchGroup profile) of members excluded due to consent.
  • name string(default "ConsentConstrainedMembers") - Fixed value "ConsentConstrainedMembers".
  • id? string - Unique id for the element within a resource.

health.fhir.r4.davincipdex220: PDexMultiMemberMatchResponseParametersParameterMatchedMembers

Closed record

Slice: MatchedMembers (1..1) — PDexMemberMatchGroup.

Fields
  • modifierExtension? Extension[] - Modifier extensions.
  • 'resource Resource - Group resource (PDexMemberMatchGroup profile) of successfully matched members.
  • name string(default "MatchedMembers") - Fixed value "MatchedMembers".
  • id? string - Unique id for the element within a resource.

health.fhir.r4.davincipdex220: PDexMultiMemberMatchResponseParametersParameterNonMatchedMembers

Closed record

Slice: NonMatchedMembers (0..1) — PDexMemberNoMatchGroup.

Fields
  • modifierExtension? Extension[] - Modifier extensions.
  • 'resource Resource - Group resource (PDexMemberNoMatchGroup profile) of members for whom no match was found.
  • name string(default "NonMatchedMembers") - Fixed value "NonMatchedMembers".
  • id? string - Unique id for the element within a resource.

Object types

health.fhir.r4.davincipdex220: BulkMemberMatcher

Defines an abstract bulk member matcher for PDex $bulk-member-match.

Implement this object type to provide custom member-matching logic for payer-to-payer bulk exchange. The operation is type-level on the Group resource: POST [base]/Group/$bulk-member-match

matchMembers

Isolated Function
function matchMembers(BulkMemberMatchResources resources) returns BulkMemberMatchResult|FHIRError

Performs member matching for multiple members in a single request.

Parameters
Return Type
  • BulkMemberMatchResult|FHIRError - A BulkMemberMatchResult with matched/unmatched/consent-constrained Group resources on success, or a r4:FHIRError if the operation fails.

health.fhir.r4.davincipdex220: DaVinciDataExporter

Defines an abstract Da Vinci data exporter for the $davinci-data-export operation.

This object serves as an interface for implementing payer-to-payer bulk data export. The operation is instance-level on Group: POST [base]/Group/[id]/$davinci-data-export Defined in Da Vinci ATR IG (used in PDex payer-to-payer exchange): http://hl7.org/fhir/us/davinci-atr/OperationDefinition/davinci-data-export

initiateExport

Isolated Function
function initiateExport(string groupId, DataExportParameters params) returns DataExportJob|FHIRError

Initiates a Da Vinci data export for the given Group instance.

Parameters
  • groupId string - The logical ID of the Group resource (from the request URL).
  • params DataExportParameters - Export parameters controlling member scope, date range, resource types, and output.
Return Type
  • DataExportJob|FHIRError - A DataExportJob with the polling URL on success, or a r4:FHIRError if the export cannot be initiated.

Import

import ballerinax/health.fhir.r4.davincipdex220;Copy

Other versions

1.0.0

Metadata

Released date: 11 days ago

Version: 1.0.0

Compatibility

Platform: any

Ballerina version: 2201.12.8

GraalVM compatible: Yes

Pull count

Total: 30

Current verison: 30

Weekly downloads

Keywords

Healthcare

FHIR

R4

DaVinci

PDex

Vendor/Other

Area/Healthcare

Type/Library

Contributors

Dependencies

ballerina/constraint/1.7.0ballerina/log/2.14.0ballerinax/health.fhir.r4/6.2.4
See more...

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2026 WSO2 LLC