Flexpa
Contact usDeveloper Portal

Getting started

  • Introduction
  • Quickstart
  • Use cases
  • Pricing
  • Patient access
  • Test mode
  • Going live
  • What we don't do
  • ChangelogUpdated
  • FAQ

Guides

  • Reading resources
  • Searching resources

Network

  • Payers
  • Endpoints

Tools

  • Flexpa Link
  • Flexpa API
  • Data analytics
  • Connections

FHIR Resources

  • Overview
  • AllergyIntolerance
  • CapabilityStatement
  • CarePlan
  • CareTeam
  • Condition
  • Coverage
  • Device
  • DiagnosticReport
  • DocumentReference
  • Encounter
  • ExplanationOfBenefit
  • Goal
  • Immunization
  • Location
  • Medication
  • MedicationDispense
  • MedicationRequest
  • Observation
  • Organization
  • Patient
  • Practitioner
  • PractitionerRole
  • Procedure
  • Provenance

About

  • Handbook
  • Brand kit
  • Join us
  • Privacy Policy
  • Privacy Notice
  • Security
  • Terms of Service

Encounter

GET https://api.flexpa.com/fhir/Encounter

  • Encounter is a base FHIR Resource ( JSON example)
  • Commonly available via US Core Encounter Profile

Encounter is a administrative FHIR Resource to record an interaction between a patient and healthcare providers for the purpose of providing healthcare services or assessing the health status of a patient.

Accessing a patient's encounter can aid in workflows such as understanding a patient's history of care and identifying gaps in care.

Many payers make this available in a basic form derived from a patient's claims, but some also provide a more detailed view of the patient's encounters if they have a more robust provider-payer clinical data exchange, such as quality measures.

Search parameters

The full list of search parameters can be found here. Some of the most important are:

Parameters

patient
string

The ID of the patient who participated in the encounter. We recommend using this search parameter along with the $PATIENT_ID wildcard

date
string

The date of the encounter.

type
string

The type of the encounter.

Sample request

While some servers may support a resource-level search without any parameters, not all do. We recommend using the format below with the patient ID via the $PATIENT_ID wildcard as a search parameter.

This is a sample request using curl

ACCESS_TOKEN=flexpa-link-access-token

curl "https://api.flexpa.com/fhir/Encounter?patient=$PATIENT_ID" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Sample response

This is a sample response from UnitedHealthcare using Flexpa API in test mode

Status TwitterGitHub

© 2023 Flexpa. All rights reserved.

On this page
  • Search parameters
  • Sample request
  • Sample response