RXNT Patient API

Summary

RXNT will make available the RXNT Patient API for third-party developers as part of the certification criteria outlined by the Office of the National Coordinator for Health Information Technology (ONC). The RXNT Patient API allows third-party developers who are developing software applications to access the Protected Health Information (PHI) of patients that are under the care of or have been under the care of providers that have used the RXNT platform. This documentation provides instructions to access RXNT Patient API, including authentication details and methods to connect to the API and retrieve PHI. 

This API deployment utilizes the Aidbox FHIR engine and is fully compliant with HL7 FHIR R4 (v4.0.1), US Core Implementation Guide v6.1.0, and USCDI v3 data standards. It meets the regulatory requirements set forth by the Office of the National Coordinator for Health Information Technology (ONC) for:

  • Application Access – Patient Selection (45 CFR 170.315(g)(7))
  • Application Access – All Data Request (45 CFR 170.315(g)(9))

Application access – patient selection (45 CFR 170.315(g)(7))

The Patient Selection endpoint receives queries containing demographic fields, uniquely identifies the corresponding patient record within the database, and returns a secure resource ID (token) needed to execute subsequent medical history requests.

Base endpoint URL

https://fhir.rxnt.com/fhir/Patient

Supported search parameters

The following search parameters can be queried independently or combined to isolate a unique patient record:

Parameter Type Description
given string The patient's first/given name
family string The patient's last/family name
birthdate date The patient's date of birth (YYYY-MM-DD)
gender token The administrative gender of the patient (male, female, other, unknown)

Sample request

HTTP

GET https://fhir.rxnt.com/fhir/Patient?given=Eve&family=Betterhalf&birthdate=1975-05-01

Sample JSON response output

JSON

{

  "resourceType": "Bundle",

  "type": "searchset",

  "total": 1,

  "entry": [

    {

      "fullUrl": "https://fhir.rxnt.com/fhir/Patient/996756495",

      "resource": {

        "resourceType": "Patient",

        "id": "996756495",

        "active": true,

        "name": [

          {

            "use": "official",

            "family": "Betterhalf",

            "given": ["Eve"]

          }

        ],

        "gender": "female",

        "birthDate": "1975-05-01",

        "extension": [

          {

            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",

            "extension": [

              { "url": "ombCategory", "valueCoding": { "system": "urn:oid:2.16.840.1.113883.6.238", "code": "2106-3", "displayName": "White" } },

              { "url": "ombCategory", "valueCoding": { "system": "urn:oid:2.16.840.1.113883.6.238", "code": "2076-8", "displayName": "Hawaiian or Other Pacific Islander" } }

            ]

          },

          {

            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",

            "extension": [

              { "url": "ombCategory", "valueCoding": { "system": "urn:oid:2.16.840.1.113883.6.238", "code": "2186-5", "displayName": "Not Hispanic or Latino" } }

            ]

          }

        ]

      }

    }

  ]

}

Application access – all data request (45 CFR 170.315(g)(9))

Once a patient's resource ID is acquired, client applications can extract all available data elements outlined across the USCDI v3 data classes. The Aidbox engine routes clinical concepts directly into specific FHIR resource endpoint patterns.

USCDI v3 data mapping matrix

USCDI v3 Data Class Mapped FHIR Resource Profile Target API Endpoint
Patient Demographics US Core Patient GET /Patient/{id}
Problems US Core Condition (Problem List) GET /Condition?patient={id}&category=problem-list-item
Health Concerns US Core Condition (Health Concern) GET /Condition?patient={id}&category=health-concern
Goals US Core Goal GET /Goal?patient={id}
Procedures & Interventions US Core Procedure / ServiceRequest

GET /Procedure?patient={id}


 

GET /ServiceRequest?patient={id}

Vital Signs US Core Vital Signs Profile GET /Observation?patient={id}&category=vital-signs
Care Team Members US Core CareTeam GET /CareTeam?patient={id}

Core clinical concepts & vocabulary systems

The integrated Aidbox platform handles vocabulary translations for common clinical assertions. Query payloads expose standard industry nomenclature including:

  • Problems / Diagnoses: Core status entries such as Pneumonia (SNOMED CT: 233604007) and Respiratory insufficiency (SNOMED CT: 409623005) are retrieved via the /Condition endpoint.
  • Health Concerns & Risks: Documented risks like Malignant neoplastic disease are exposed under the /Condition?category=health-concern parameters.
  • Care Goals: Expected patient metrics, such as a target Pulse Oximetry threshold of 92% or greater, are hosted under /Goal.
  • Interventions: Executed actions or planned clinical adjustments—including "Elevate head of bed" (SNOMED CT: 423171007) and "Oxygen administration by nasal cannula" (SNOMED CT: 371907003)—are exposed via /Procedure and /ServiceRequest.
  • Clinical Evaluations & Outcomes: Actual recorded vitals, such as a localized Pulse Oximetry Panel (LOINC: 44616-1) returning an outcome value of 95%, are stored and queried via /Observation.

Date criteria filtering for all data request (§ 170.315(g)(9)) & VDT

To fulfill the ONC regulatory mandates governing All Data Request capabilities and View, Download, and Transmit (VDT) actions, our Patient API permits client applications and portal interfaces to constrain data retrieval operations using historical milestones or strict temporal intervals.

The underlying Aidbox FHIR instance dynamically structures chronological parameters according to standard FHIR search specification architectures.

Supported date search prefixes

When constructing time-restricted queries against USCDI v3 tracking arrays (including /Observation, /Condition, /Procedure, or /Encounter), operators must append core relational prefixes directly ahead of the target date string value:

Prefix Definition Description Example URL Syntax
eq Equal Matches data recorded precisely within the specified date precision block. date=eq2024-04-11
gt Greater Than Filters exclusively for records generated strictly after the designated date. date=gt2024-04-11
ge Greater Than or Equal Filters for records generated on or after the designated date. date=ge2024-04-11
lt Less Than Filters exclusively for records generated strictly prior to the designated date. date=lt2024-04-11
le Less Than or Equal Filters for records generated on or before the designated date. date=le2024-04-11

Formatting standards

Date criteria expressions must consistently map to standard ISO 8601 layouts:

  • Calendar Date Precision: YYYY-MM-DD (e.g., 2026-06-26)
  • Complete Time & Timezone Offset: YYYY-MM-DDThh:mm:ss[Z|(+/-)hh:mm] (e.g., 2026-06-26T14:30:00-05:00)

Sample range filtering syntaxes

To pull data bound between a verified start and end interval, supply the targeted resource parameter twice within the query array to initialize an implicit boolean AND constraint.

  • Retrieving Vital Sign Records Within a Defined Calendar Year:

GET https://fhir.rxnt.com/fhir/Observation?patient=996756495&category=vital-signs&date=ge2025-01-01&date=le2025-12-31

  • Retrieving Procedures Executed From a Specific Time Forward:

GET https://fhir.rxnt.com/fhir/Procedure?patient=996756495&date=ge2026-03-15

Connection security & registration

Mandatory Security Standards: All client application endpoints require authorization protocols matching the SMART on FHIR Framework (OAuth 2.0). Data payloads are protected in transit using TLS 1.2 or higher encryption.

To request developer credentials, sandbox environment variables, or production API verification keys, please submit an integration request directly to our clinical interface desk at integration@rxnt.com or log into the RXNT Partner Dashboard to complete your API application profile.


 

Was this article helpful?
2 out of 4 found this helpful