Health Gorilla · Arazzo Workflow

Health Gorilla Coverage Retrieval

Version 1.0.0

Locate a patient, search their insurance Coverage resources, then read a single Coverage for full plan detail.

1 workflow 1 source API 1 provider
View Spec View on GitHub HealthInteroperabilityFHIRClinical DataLab OrderingArazzoWorkflows

Provider

health-gorilla

Workflows

coverage-retrieval
Retrieve insurance Coverage resources and full plan detail for a matched patient.
Finds the patient by date of birth, searches their Coverage resources, and reads a single Coverage by id for full plan and payer detail.
3 steps inputs: birthdate outputs: coverage, coverageDetail, patientId
1
findPatient
searchPatients
Locate the patient by date of birth.
2
getCoverage
searchCoverage
Search the patient's insurance Coverage resources.
3
readCoverage
readCoverage
Read a single Coverage resource by id for full plan detail.

Source API Descriptions

Arazzo Workflow Specification

Raw ↑
arazzo: 1.0.1
info:
  title: Health Gorilla Coverage Retrieval
  summary: Locate a patient, search their insurance Coverage resources, then read a single Coverage for full plan detail.
  description: >-
    An insurance-coverage flow against the Health Gorilla FHIR R4 clinical and
    lab network API. The patient is located by demographics, their Coverage
    resources are searched within the patient compartment, and a single Coverage
    is read by id for complete plan and payer detail. This mirrors the US Core
    Coverage retrieval pattern over the /fhir/R4 server base. Every step inlines
    its request so the flow is self-contained.
  version: 1.0.0
sourceDescriptions:
- name: healthGorillaFhir
  url: ../openapi/health-gorilla-openapi.yml
  type: openapi
workflows:
- workflowId: coverage-retrieval
  summary: Retrieve insurance Coverage resources and full plan detail for a matched patient.
  description: >-
    Finds the patient by date of birth, searches their Coverage resources, and
    reads a single Coverage by id for full plan and payer detail.
  inputs:
    type: object
    required:
    - birthdate
    properties:
      birthdate:
        type: string
        description: Patient date of birth (YYYY-MM-DD) to locate the coverage subject.
  steps:
  - stepId: findPatient
    description: Locate the patient by date of birth.
    operationId: searchPatients
    parameters:
    - name: birthdate
      in: query
      value: $inputs.birthdate
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      patientId: $response.body#/entry/0/resource/id
  - stepId: getCoverage
    description: Search the patient's insurance Coverage resources.
    operationId: searchCoverage
    parameters:
    - name: patient
      in: query
      value: $steps.findPatient.outputs.patientId
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      coverage: $response.body
      coverageId: $response.body#/entry/0/resource/id
  - stepId: readCoverage
    description: Read a single Coverage resource by id for full plan detail.
    operationId: readCoverage
    parameters:
    - name: id
      in: path
      value: $steps.getCoverage.outputs.coverageId
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      coverageDetail: $response.body
  outputs:
    patientId: $steps.findPatient.outputs.patientId
    coverage: $steps.getCoverage.outputs.coverage
    coverageDetail: $steps.readCoverage.outputs.coverageDetail