The Smile CDR Prior Auth solution is mainly offered as part of three modules :
V2026.02+ is recommended. If you're using an older version, please reach out to our support team for further guidance.| Operation | Description |
|---|---|
<cds-hooks-endpoint>/cds-services | Discovery endpoint of the CDS hooks module |
<cds-hooks-endpoint>/cds-services/<service-id> | Hook invocation endpoint |
# CDS Hooks Endpoint
module.cds_hooks_endpoint.type=ENDPOINT_CDS_HOOKS
module.cds_hooks_endpoint.config.port=8016
# security module
module.cds_hooks_endpoint.requires.SECURITY_IN_UP=local_security
module.cds_hooks_endpoint.requires.ENDPOINT_FHIR=fhir_endpoint
# CRD Module
module.prior_auth_crd.type=PRIOR_AUTH_CRD
module.prior_auth_crd.requires.ENDPOINT_CDS_HOOKS=cds_hooks_endpoint
module.prior_auth_crd.config.cds_hook.file=classpath:/config/cds-hooks.json
module.prior_auth_crd.config.routes.script.file=classpath:/config/crd-routes.xml
module.prior_auth_crd.config.functions.script.file=classpath:/config/crd-functions.js
Define which hooks CRD responds to: An optional extension block can be included in each hook definition to advertise capabilities in the CDS service discovery response (/cds-services). The extension properties are passed through as-is — include any DaVinci-standard or implementation-specific keys EHR clients require.
Note: The
davinci-crd.versionextension is a required extension for CRD. Each registered CDS Hook instance must declare a single version, either 2.1 or 2.2; the module logs a warning when a hook declares none or more than one. Thedavinci-crd.requestedVersionrequest extension of STU 2.2 is not used. See Supported Implementation Guide Versions.
Note: Starting
v2026.05.R01, thedavinci-crd.configuration-optionsextension is no longer injected automatically. If you want to advertise CRD configuration options (e.g.,coverage-info,max-cards), you must include them explicitly in theextensionblock as shown below.
Note: By default, the module fetches the prefetch resources that a request does not supply. To make server-side prefetch optional, set Enable Server-Side Prefetch (
server_prefetch_enabled) on the module, or setsmile.server-prefetch-enabledin theextensionblock of a single hook. See Server-Side Prefetch.
[
{
"hook": "order-sign",
"title": "Order Sign CRD",
"description": "Evaluates orders for prior auth requirements",
"prefetch": {
"patient": "Patient/{{context.patientId}}",
"coverageBundle": "Coverage?patient={{context.patientId}}&status=active&_include=Coverage:payor"
},
"extension": {
"davinci-crd.version": ["2.1"],
"davinci-crd.configuration-options": [
{
"code": "coverage-info",
"type": "boolean",
"name": "Coverage Information",
"description": "Indicates whether coverage information should be returned",
"default": true
},
{
"code": "max-cards",
"type": "integer",
"name": "Maximum cards",
"description": "Indicates the maximum number of cards to be returned from the service",
"default": 10
}
]
}
},
{
"hook": "appointment-book",
"title": "Appointment Book CRD",
"prefetch": {
"patient": "Patient/{{context.patientId}}",
"coverageBundle": "Coverage?patient={{context.patientId}}&status=active"
},
"extension": {
"davinci-crd.version": ["2.1"],
"com.example.cdshooks.request.cds-hooks-specification-version": "2.1",
"com.example.cdshooks.request.fhir-version": "R4"
}
}
]
This is an example CRD Camel route to generate a static response using JS:
<routes>
<route>
<from uri="direct:start-crd"/>
<to uri="smile:camel/script?function=makeCustomResponse&includeExchange=true"/>
</route>
</routes>
JavaScript function which will be invoked by camel route to get a static response:
function makeCustomResponse(theRequest, theExchange) {
let response = {
"cards": [
{
"summary": "This response is coming from " + theRequest.hook,
"indicator": "info",
"source": {
"label": "Test label from " + theRequest.hook
}
}
]
};
return JSON.stringify(response);
}
Every CDS Hooks request starts in the direct:start-crd route. To send different requests to different CDS engines or rules, for example by the codes of the ordered services, a JavaScript function can inspect the request and store the name of the target route in the routeName exchange property. The route then calls it with toD, which resolves the URI for each request. The CRD module also records the routeName value in the transaction log entry of the response.
<routes>
<route>
<from uri="direct:start-crd"/>
<!-- selectCrdRoute picks the downstream route by looking up the CPT codes of the orders.
It could also call an external service that determines which downstream service to call. -->
<to uri="smile:camel/script?function=selectCrdRoute&includeExchange=true"/>
<toD uri="direct:${exchangeProperty.routeName}"/>
</route>
<route>
<from uri="direct:crd-imaging"/>
<!-- Call the CDS engine for imaging orders here -->
<to uri="smile:camel/script?function=makeCustomResponse&includeExchange=true"/>
</route>
<route>
<from uri="direct:crd-default"/>
<!-- Call the default CDS engine here -->
<to uri="smile:camel/script?function=makeCustomResponse&includeExchange=true"/>
</route>
</routes>
The selectCrdRoute function in crd-functions.js reads the CPT codes of the orders with a FHIRPath expression and picks the route of the first code it recognizes. Requests without a recognized code go to crd-default.
const routeByCptCode = {
'70551': 'crd-imaging',
'70553': 'crd-imaging'
};
function selectCrdRoute(theRequest, theExchange) {
const ordersKey = theRequest.hook === 'appointment-book' ? 'appointments' : 'draftOrders';
const orders = theRequest.context[ordersKey];
const codes = orders ? orders.evaluateFhirPath(
"Bundle.entry.resource.descendants().where($this.is(CodeableConcept))" +
".coding.where(system = 'http://www.ama-assn.org/go/cpt').code") : [];
let route = 'crd-default';
for (let i = 0; i < codes.length; i++) {
if (routeByCptCode[codes[i]]) {
route = routeByCptCode[codes[i]];
break;
}
}
theExchange.properties['routeName'] = route;
}
Note: This example reads the orders from the draftOrders context of order-sign and order-select, and from appointments for appointment-book. For order-dispatch, the context contains references to the dispatched orders, so read the order resources from the prefetch instead. Each route name the function returns must match a direct: route, or the request fails. The whole request, with all of its orders, goes to the selected route, so in this example an order-sign request with an imaging order and another order is evaluated by crd-imaging. To evaluate orders with different services, split the orders into separate requests and merge the returned cards and system actions. See Prior Auth CRD Module Overview for routes that call a CQL engine.
GET request on <cds-hooks-endpoint>/cds-services. You should see 2 sample services registered like below :{
"services": [
{
"extension": {
"davinci-crd.version": ["2.1"],
"davinci-crd.configuration-options": [
{
"code": "coverage-info",
"type": "boolean",
"name": "Coverage Information",
"description": "Indicates whether coverage information should be returned",
"default": true
},
{
"code": "max-cards",
"type": "integer",
"name": "Maximum cards",
"description": "Indicates the maximum number of cards to be returned from the service",
"default": 10
}
]
},
"hook": "order-sign",
"title": "Order Sign CRD",
"description": "Evaluates orders for prior auth requirements",
"id": "prior_auth_crd_order_sign",
"prefetch": {
"patient": "Patient/{{context.patientId}}",
"coverageBundle": "Coverage?patient={{context.patientId}}&status=active&_include=Coverage:payor"
}
},
{
"extension": {
"davinci-crd.version": ["2.1"],
"com.example.cdshooks.request.cds-hooks-specification-version": "2.1",
"com.example.cdshooks.request.fhir-version": "R4"
},
"hook": "appointment-book",
"title": "Appointment Book CRD",
"id": "prior_auth_crd_appointment_book",
"prefetch": {
"patient": "Patient/{{context.patientId}}",
"coverageBundle": "Coverage?patient={{context.patientId}}&status=active"
}
}
]
}
id for each service, it is essentially <module_id_for_crd>_<hook_id_with_underscores>. This is on purpose to avoid conflicts in case multiple PriorAuth CRD modules end up registering same hooks against a single CDS hook endpoint.POST request on <cds-hooks-endpoint>/cds-services/prior_auth_crd_order_sign with content type Content-Type: application/json & the request body below :INVOKE_CDS_HOOKS.{
"hookInstance": "698dda66-9a2f-464a-8edb-58dfca80aa07",
"hook": "order-sign",
"context": {
"patientId": "provider-patient-carol"
},
"prefetch": {
"coverageBundle": {
"resourceType": "Bundle",
"id": "f86f42d2-3067-4693-b8ab-78a61153138d",
"meta": {
"lastUpdated": "2024-09-06T13:48:41.747-04:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "http://localhost:8005/Coverage?patient=provider-patient-carol&status=active&_include=Coverage:payor"
}
],
"entry": [
{
"fullUrl": "http://localhost:8005/Coverage/provider-coverage-carol",
"resource": {
"resourceType": "Coverage",
"id": "provider-coverage-carol",
"meta": {
"versionId": "1",
"lastUpdated": "2024-09-09T04:16:10.665-04:00",
"source": "#wUvugjq2zCvGu4fE"
},
"identifier": [
{
"system": "http://acme.org/fhir-ns/payer-coverage-identifier-system",
"value": "1234-COVERAGE-IDENTIFIER"
}
],
"status": "active",
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "EHCPOL",
"display": "extended healthcare"
}
]
},
"policyHolder": {
"reference": "Organization/payor-organization-acme"
},
"subscriber": {
"reference": "Patient/provider-patient-carol"
},
"beneficiary": {
"reference": "Patient/provider-patient-carol"
},
"dependent": "0",
"relationship": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/subscriber-relationship",
"code": "self"
}
]
},
"period": {
"start": "2011-05-23",
"end": "2025-05-23"
},
"payor": [
{
"reference": "Organization/payor-organization",
"display": "Payor"
}
],
"class": [
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/coverage-class",
"code": "group"
}
]
},
"value": "CB135",
"name": "Corporate Baker's Inc. Local #35"
}
]
},
"search": {
"mode": "match"
}
}
]
},
"patient": {
"resourceType": "Patient",
"id": "provider-patient-carol",
"meta": {
"versionId": "1",
"lastUpdated": "2024-09-09T04:16:10.665-04:00",
"source": "#wUvugjq2zCvGu4fE",
"profile": [
"http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Patient|2.0.0"
]
},
"language": "en-US",
"identifier": [
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MB",
"display": "Member Number"
}
],
"text": "An identifier for the insured of an insurance policy (this insured always has a subscriber), usually assigned by the insurance carrier."
},
"system": "https://www.upmchealthplan.com/fhir/memberidentifier",
"value": "1234-TEST-MB"
},
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MR",
"display": "Medical Record number"
}
],
"text": "Medical Record Number"
},
"system": "https://www.some-system.com",
"value": "1234-TEST-MRN"
}
],
"active": true,
"name": [
{
"family": "Johnson",
"given": [
"Carol"
]
}
],
"telecom": [
{
"system": "phone",
"value": "5555555551",
"rank": 1
}
],
"gender": "female",
"birthDate": "1943-01-01",
"address": [
{
"type": "physical",
"line": [
"123 Murray Avenue"
],
"city": "PITTSBURGH",
"state": "PA",
"postalCode": "15217"
}
],
"maritalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",
"code": "M"
}
]
},
"communication": [
{
"language": {
"coding": [
{
"system": "urn:ietf:bcp:47",
"code": "en"
}
],
"text": "English"
},
"preferred": true
}
],
"managingOrganization": {
"reference": "Organization/payor-organization"
}
}
}
}
You should see the static response below, which is returned from camel routes:
{
"cards": [
{
"summary": "This response is coming from order-sign",
"indicator": "info",
"source": {
"label": "Test label from order-sign"
}
}
]
}
The Prior Auth PAS module registers the DTR operations $questionnaire-package, $next-question, and $log-questionnaire-errors. Each operation calls its own Camel route (direct:start-questionnaire-package, direct:start-next-question, and direct:log-questionnaire-errors), which can be connected to any proprietary rules engine interface using Camel processors.
| Operation | Description |
|---|---|
Questionnaire/$questionnaire-package | Retrieve questionnaire with dependencies |
Questionnaire/$next-question | Adaptive questionnaire support |
Questionnaire/$log-questionnaire-errors | Allows submission of issues encountered when working with DTR artifacts |
The CQL and DTR modules are back end systems that the PAS module's Camel routes call over HTTP. The PAS module does not declare a dependency on them.
# CQL Module (optional)
module.cql.type=CQL
module.cql.requires.ENDPOINT_FHIR=fhir_endpoint
# DTR Module (optional)
module.dtr.type=PRIOR_AUTH_DTR
module.dtr.requires.CQL=cql
module.dtr.requires.ENDPOINT_FHIR=fhir_endpoint
module.dtr.config.enable_questionnaire_package=true
# PAS Module
module.prior_auth_pas.type=PRIOR_AUTH_PAS
module.prior_auth_pas.requires.ENDPOINT_FHIR=fhir_endpoint_payer
module.prior_auth_pas.config.routes.script.file=classpath:/config/pas-routes.xml
module.prior_auth_pas.config.functions.script.file=classpath:/config/pas-functions.js
Note: Attach the DTR module and the PAS module to different FHIR endpoints, because both can register Questionnaire/$questionnaire-package. The PAS module reports a configuration warning whenever a PRIOR_AUTH_DTR module is attached to the same FHIR endpoint. In the example above, the DTR module is attached to fhir_endpoint and the PAS module to fhir_endpoint_payer. See Configuration Properties for the other PAS module properties.
The $questionnaire-package operation sends the request Parameters to the direct:start-questionnaire-package route. The route can forward the request over HTTP to the Questionnaire/$questionnaire-package operation of the FHIR endpoint the DTR module is attached to. The response of that call becomes the response of the operation.
Example showing simple $questionnaire-package, $submit and $log-questionnaire-errors routes.
<routes>
<route>
<from uri="direct:start-questionnaire-package"/>
<marshal>
<fhirJson/>
</marshal>
<setHeader name="CamelHttpMethod">
<constant>POST</constant>
</setHeader>
<setHeader name="Content-Type">
<constant>application/fhir+json</constant>
</setHeader>
<to uri="smile:camel/script?function=setDtrAuthHeader&includeExchange=true"/>
<to uri="http://localhost:8000/fhir/Questionnaire/$questionnaire-package?bridgeEndpoint=true"/>
</route>
<route>
<from uri="direct:start-pas-submit"/>
<log message="----------------------- default processor triggered from PAS"/>
<to uri="bean:pasRequestBundleValidator"/>
<to uri="bean:createPendedPASResponseProcessor"/>
<to uri="bean:pasResponseBundleValidator"/>
</route>
<route id="log-questionnaire-errors-route">
<from uri="direct:log-questionnaire-errors"/>
<!-- Forward to your downstream processing here -->
<to uri="stub:nowhere"/>
</route>
</routes>
The DTR endpoint must authenticate the call. In this example, the setDtrAuthHeader function in pas-functions.js sets an HTTP Basic Authorization header for a system user that has permission to invoke Questionnaire/$questionnaire-package on that endpoint, and reads the password from the JS_SYSTEM_USER_PASSWORD environment variable with the Environment API, which only reads variables whose names start with JS_ or js.. The Converter API encodes the credentials.
function setDtrAuthHeader(message, exchange) {
const username = 'SYSTEM-USER-DTR';
// Example only: in production, retrieve the password from a secrets vault instead of an environment variable
const password = Environment.getEnv('JS_SYSTEM_USER_PASSWORD');
exchange.headers['Authorization'] = 'Basic ' + Converter.base64Encode(username + ':' + password);
}
The DTR endpoint must have security.http.basic.enabled set to true for this header to be accepted. If the DTR endpoint uses OpenID Connect instead, set a Bearer token in the Authorization header.
The $next-question operation sends the provider's QuestionnaireResponse to the direct:start-next-question Camel route. That route uses the dtrNextQuestionProcessor processor to choose the route that generates the next question(s) for each adaptive Questionnaire.
For each adaptive Questionnaire, store a Questionnaire in the payer's FHIR repository with:
url as the adaptive Questionnaire that the provider sends in the $next-question request. The provider must send the adaptive Questionnaire as a contained resource of the QuestionnaireResponse, referenced by its questionnaire element.status of active.https://smiledigitalhealth.com/cms/questionnaire-route, whose value names the route to use.{
"resourceType": "Questionnaire",
"url": "http://example.com/fhir/Questionnaire/home-o2-adaptive",
"status": "active",
"identifier": [
{
"system": "https://smiledigitalhealth.com/cms/questionnaire-route",
"value": "DefaultAdaptiveRoute"
}
]
}
The processor finds the matching Questionnaire and sets the targetRoute exchange property to the identifier value. If the QuestionnaireResponse has no contained Questionnaire with a url, or no active Questionnaire with that url and identifier exists, the processor sets the message body to an OperationOutcome, and the operation returns 422 Unprocessable Entity.
The following routes send each request to direct:nq-<identifier value>. The target route must set the message body to the resulting QuestionnaireResponse.
<routes>
<route id="next_question_adaptive_route_resolution">
<from uri="direct:start-next-question"/>
<to uri="bean:dtrNextQuestionProcessor"/>
<choice>
<when>
<simple>${exchangeProperty.targetRoute} != null</simple>
<toD uri="direct:nq-${exchangeProperty.targetRoute}"/>
</when>
<otherwise>
<to uri="stub:nowhere"/>
</otherwise>
</choice>
</route>
<route id="next_question_default_adaptive_route">
<from uri="direct:nq-DefaultAdaptiveRoute"/>
<!-- Generate the next question(s) and set the QuestionnaireResponse as the message body here -->
<to uri="stub:nowhere"/>
</route>
</routes>
The PAS module registers the PAS operations for adjudication. PAS Camel routes can be configured to handle the Claim adjudication response synchronously or asynchronously. In the case of asynchronous response the Camel route will need to be configured to return a Pended ClaimResponse.
| Operation | Description |
|---|---|
Claim/$submit | Submit prior auth request |
Claim/$inquire | Check status of existing request |
ClaimResponse/$sdh.pa.submit | ClaimResponse submission for payers to asynchronously send ClaimResponse updates |
# PAS Module
module.prior_auth_pas.type=PRIOR_AUTH_PAS
module.prior_auth_pas.requires.ENDPOINT_FHIR=fhir_endpoint_payer
module.prior_auth_pas.config.payer_system_item_trn=http://sdh-mockpayer.org/ITEM_TRACE_NUMBER
module.prior_auth_pas.config.organization_npi_identifier_code_systems=http://hl7.org/fhir/sid/us-npi
module.prior_auth_pas.config.practitioner_npi_identifier_code_systems=http://hl7.org/fhir/sid/us-npi
module.prior_auth_pas.config.routes.script.file=classpath:/config/pas-routes.xml
# Only required when using the pasToCqlRequestProcessor and cqlToPasResponseProcessor processors (see below)
module.prior_auth_pas.config.definitions.spring_context_config.class=cdr.prior.auth.adjudication.AdjudicationAppCtx
organization_npi_identifier_code_systems and practitioner_npi_identifier_code_systems are required. They set the identifier systems used to find the Organization and Practitioner resources that match a prior authorization request.payer_system_item_trn sets the identifier system of the payer's item trace numbers.To invoke the PlanDefinition there are 2 helper Camel processors available:
pasToCqlRequestProcessor to generate the PlanDef requestcqlToPasResponseProcessor to parse the PlanDef response and generate a PASResponseBundleNote: The above processors are part of a customized JAR deliverable and can be obtained from Smile Support or your Technical Account Manager. Place the JAR file in the smilecdr/customerlib folder and set definitions.spring_context_config.class to cdr.prior.auth.adjudication.AdjudicationAppCtx, as shown above.
There are also 2 optional Camel Processors available via the PAS module of Smile.
pasRequestBundleValidator to validate the incoming PAS bundle to spec.pasResponseBundleValidator to validate the outgoing response bundle to spec.Note: Both validators read the message body without consuming it, so they can be placed anywhere in the route.
Do not set disableStreamCache=true on an HTTP endpoint whose response feeds pasResponseBundleValidator - that will produce a single-read stream, and any step after the validator will see an empty body.
<routes>
<route>
<from uri="direct:start-pas-submit"/>
<!-- Optional Request Validation -->
<to uri="bean:pasRequestBundleValidator"/>
<!-- CQL-based adjudication -->
<to uri="bean:pasToCqlRequestProcessor"/>
<to uri="http://localhost:8002/fhir/PlanDefinition/$r5.apply?bridgeEndpoint=true"/>
<to uri="bean:cqlToPasResponseProcessor"/>
<!-- Optional Response Validation -->
<to uri="bean:pasResponseBundleValidator"/>
</route>
</routes>
Claim/$inquire has its own route, direct:start-pas-inquire. Two Camel processors are available via the PAS module of Smile:
pasInquiryRequestBundleValidator to validate the incoming PAS inquiry request bundle to spec.createInquireResponseProcessor to retrieve the latest adjudication response from the local repository and generate the inquiry response.Replace createInquireResponseProcessor with a call to your own payer or adjudication system to answer inquiries from that system instead.
<routes>
<route>
<from uri="direct:start-pas-inquire"/>
<!-- Optional Request Validation -->
<to uri="bean:pasInquiryRequestBundleValidator"/>
<!-- Default adjudication status lookup -->
<to uri="bean:createInquireResponseProcessor"/>
</route>
</routes>
PAS stores each request and response as a Bundle, and finds them with custom SearchParameters on Bundle. Install the SearchParameters below on the persistence module of the FHIR endpoint that the PAS module depends on, before PAS receives requests. Without them, the operations below fail.
| SearchParameter | Used by |
|---|---|
claim.identifier | Claim/$submit: rejects a claim whose identifier was already submitted, and finds the original claim when a claim is updated. |
claimresponse.identifier | ClaimResponse/$sdh.pa.submit: finds an existing response Bundle to update. Claim/$inquire: finds the latest response for the claim. |
The other SearchParameters in the Bundle (claim, claim.profile, claimresponse and claimresponse.profile) are not used by the PAS module, but let clients and Subscriptions search the stored Bundles by their Claim or ClaimResponse.
{
"resourceType": "Bundle",
"type": "transaction",
"entry": [
{
"resource": {
"id": "sp-bundle-claim",
"resourceType": "SearchParameter",
"url": "http://hl7.org/fhir/SearchParameter/bundle-claim",
"name": "Bundle-claim",
"status": "active",
"description": "This parameter, of type reference, specifies the Claim resource instance in the Bundle.",
"code": "claim",
"base": [
"Bundle"
],
"type": "reference",
"expression": "Bundle.entry.select(resource as Claim)",
"target": [
"Claim"
]
},
"request": {
"method": "POST",
"url": "SearchParameter",
"ifNoneExist": "code=claim&base=Bundle"
}
},
{
"resource": {
"id": "sp-bundle-claim-identifier",
"resourceType": "SearchParameter",
"url": "http://example.org/SearchParameter/bundle-claim-identifier",
"name": "claim.identifier",
"status": "active",
"description": "This parameter, of type token, specifies the identifier of the Claim.",
"code": "claim.identifier",
"base": [
"Bundle"
],
"type": "token",
"expression": "Bundle.entry.select(resource as Claim).identifier"
},
"request": {
"method": "POST",
"url": "SearchParameter",
"ifNoneExist": "code=claim.identifier&base=Bundle"
}
},
{
"resource": {
"id": "sp-bundle-claim-profile",
"resourceType": "SearchParameter",
"url": "http://example.org/SearchParameter/bundle-claim-profile",
"name": "claim.profile",
"status": "active",
"description": "This parameter, of type uri, specifies the profile of the Claim.",
"code": "claim.profile",
"base": [
"Bundle"
],
"type": "uri",
"expression": "Bundle.entry.select(resource as Claim).meta.profile"
},
"request": {
"method": "POST",
"url": "SearchParameter",
"ifNoneExist": "code=claim.profile&base=Bundle"
}
},
{
"resource": {
"id": "sp-bundle-claim-response",
"resourceType": "SearchParameter",
"url": "http://hl7.org/fhir/SearchParameter/bundle-claimresponse",
"name": "Bundle-claimresponse",
"status": "active",
"description": "This parameter, of type reference, specifies the ClaimResponse resource instance in the Bundle.",
"code": "claimresponse",
"base": [
"Bundle"
],
"type": "reference",
"expression": "Bundle.entry.select(resource as ClaimResponse)",
"target": [
"ClaimResponse"
]
},
"request": {
"method": "POST",
"url": "SearchParameter",
"ifNoneExist": "code=claimresponse&base=Bundle"
}
},
{
"resource": {
"id": "sp-bundle-claim-response-identifier",
"resourceType": "SearchParameter",
"url": "http://example.org/SearchParameter/bundle-claimresponse-identifier",
"name": "claimresponse.identifier",
"status": "active",
"description": "This parameter, of type token, specifies the identifier of the ClaimResponse.",
"code": "claimresponse.identifier",
"base": [
"Bundle"
],
"type": "token",
"expression": "Bundle.entry.select(resource as ClaimResponse).identifier"
},
"request": {
"method": "POST",
"url": "SearchParameter",
"ifNoneExist": "code=claimresponse.identifier&base=Bundle"
}
},
{
"resource": {
"id": "sp-bundle-claim-response-profile",
"resourceType": "SearchParameter",
"url": "http://example.org/SearchParameter/bundle-claimresponse-profile",
"name": "claimresponse.profile",
"status": "active",
"description": "This parameter, of type uri, specifies the profile of the ClaimResponse.",
"code": "claimresponse.profile",
"base": [
"Bundle"
],
"type": "uri",
"expression": "Bundle.entry.select(resource as ClaimResponse).meta.profile"
},
"request": {
"method": "POST",
"url": "SearchParameter",
"ifNoneExist": "code=claimresponse.profile&base=Bundle"
}
}
]
}
In case the provider wants to subscribe to get ClaimResponse updates a Subscription module has to be configured on the same persistence that PAS (FHIR Endpoint) depends on.
Example Subscription:
{
"resourceType": "Bundle",
"type": "transaction",
"entry": [
{
"resource": {
"resourceType": "Basic",
"id": "r4-backport-basic-resource",
"extension": [
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-SubscriptionTopic.url",
"valueUri": "http://example.org/SubTopics/claim-response-update"
},
{
"url": "http://hl7.org/fhir/4.3/StructureDefinition/extension-SubscriptionTopic.resourceTrigger",
"extension": [
{
"url": "description",
"valueString": "Trigger on update of ClaimResponse resources"
},
{
"url": "resource",
"valueUri": "ClaimResponse"
},
{
"url": "supportedInteraction",
"valueCode": "update"
}
]
}
],
"modifierExtension": [
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-SubscriptionTopic.status",
"valueString": "active"
}
],
"code": {
"coding": [
{
"system": "http://hl7.org/fhir/fhir-types",
"code": "SubscriptionTopic"
}
]
}
},
"request": {
"method": "PUT",
"url": "Basic/r4-backport-basic-resource"
}
},
{
"resource": {
"resourceType": "Subscription",
"id": "r4-backport-subscription",
"meta": {
"profile": [
"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription"
],
"tag": [
{
"system": "http://hapifhir.io/fhir/StructureDefinition/subscription-matching-strategy",
"code": "TOPIC",
"display": "SubscriptionTopic"
}
]
},
"status": "requested",
"reason": "Monitor update of Claim Response resources",
"criteria": "http://example.org/SubTopics/claim-response-update",
"_criteria": {
"extension": [
{
"url": "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria",
"valueString": "ClaimResponse?"
}
]
},
"channel": {
"type": "rest-hook",
"endpoint": "https://hapi.requestcatcher.com/test",
"payload": "application/fhir+json"
}
},
"request": {
"method": "PUT",
"url": "Subscription/r4-backport-subscription"
}
}
]
}