Create a Document Query Endpoint

This topic provides information on creating document query endpoints using Oracle Health Clinical Data Exchange.

A document query endpoint is a URL provided by the Oracle Health Clinical Data Exchange service that payers can use to request information from providers. You can create FHIR document query endpoints in Oracle Health Clinical Data Exchange.

Note:

You can create up to 25 document query endpoints per tenancy. If you want to use more than 25 document query endpoints, you can request a limit increase using the Limit and Quota Console.

Oracle Health Clinical Data Exchange creates C-CDA documents for clinical data from requested patient encounters retrieved from provider EHRs, along with unstructured clinical notes included as C62 documents. These C-CDA documents include the following data concepts if enabled by the provider:

• Patient (required)
• Encounter (required)
• Practitioner (required)
• Provenance (required)
• Allergy Intolerance
• Condition
• Immunization
• Medication Request
• Procedure
• Social History
• Vital Signs
• Laboratory Result
• Care Plan
• Care Team
• Device
• Goal
• Practitioner
• Document Reference
• Diagnostic Report
• Medication Administration

Complete the following steps to create a document query endpoint:

1. With Oracle Health Clinical Data Exchange open, select Document query endpoints in the navigation pane. The Document query endpoints page is displayed.

   Note:

   You must have completed the prerequisites including created a client application before you can create a document query endpoint.
2. Select Create document query endpoint. The Create document query endpoint wizard is displayed.
3. Enter a descriptive name for the endpoint in the Display Name box.
4. Enter a meaningful description of the endpoint in the Description box.
5. Select the applicable compartment in the Create document query endpoint in compartment box.
6. Select the applicable identity domain in the Identity Domain box. Select Change compartment if the identity domain you want to select is not associated with the compartment you selected in Step 5.
7. Select the applicable client application ID in the App Client Id box.
8. Optionally, select the applicable CA bundle in the CA bundle Id box.
9. If you selected a CA bundle in Step 8, complete the following optional steps as applicable:
   1. Select the Add common name (CA) and subject alternative names (SAN) to CA bundle checkbox.
   2. Enter a common name (CN) in the Common name (CN) box.
   3. Select Add subject alternative name (SAN) and enter a subject alternative name (SAN) in the Subject alternative name (SAN) box. Repeat this step as needed to add up to five SANs.
10. If you want to use tags, complete the following optional steps:
    1. Select Show advanced options.
    2. Select the applicable tag in the Tag namespace box. If you want to enter a freeform tag, select None (add a free-form tag).
    3. Select the applicable tag key in the Tag key box. If you are entering a freeform tag, enter the tag key that you want to use.
    4. Enter the applicable tag value in the Tag value box.
    5. If you want to add additional tags, select Add tag and repeat the above substeps as needed.
11. Select Create document query endpoint. The Document query endpoint page is displayed.

After you complete the above steps, the system begins creating the endpoint. Progress is displayed on the Work Requests page. When the endpoint is created, you can view details about the endpoint, edit the endpoint details, add tags, or delete the endpoint.

See the below example of a document query endpoint where xxxxx is the customer-specific environment identifier.

{
    "payerId": "ocid1.cdexhubpayer.oc1.iad.xxxxx",
    "framework": "FHIR",
    "identityDomainUrl": "https://idcs-xxxxx.identity.oraclecloud.com:443",
    "displayName": "Payer Query Endpoint 1",
    "description": "Query endpoint to make fhir calls.",
    "compartmentId": "ocid1.compartment.oc1..xxxx",
    "clientAppDetails":
    {
        "clientId": "xxxxx"
    }
}