---
title: "Export a list of patient references"
method: GET
path: "/main/Patient/$export-ids"
tags: ["Patient"]
---

# Export a list of patient references

`GET /main/Patient/$export-ids`

Exports a list of patient references that the user is allowed to access. This is more performant than using the /Patient endpoint

## Response `200`

A list of patient ids

- PatientParametersResource — Demographics and other administrative information about an individual or animal receiving care or other health-related services. See https://www.hl7.org/fhir/R4/patient.html
  - `resourceType` string, nullable
  - `id` string, nullable — Logical id of this artifact
  - `parameter` FhirParameter[] — Parameter related to this FhirParameters
    - `name` string — Name of parameter
    - `valueString` string, nullable
    - `valueDateTime` string, date-time, nullable
    - `valueBoolean` boolean, nullable
    - `valueReference` FhirReference
      - `reference` string, required — The URL (relative or absolute) to the resource being referenced
      - `type` 'Organization' | 'Patient' | 'Practitioner' | 'PractitionerRole' | 'Appointment' | 'Coverage' | 'Invoice' | 'Communication' | 'Group' | 'DocumentReference' | 'InvoiceLine' | 'PaymentTransaction' | 'Referral' | 'ReferralDefinition' | 'Schedule' | 'Slot' | 'HealthcareService' | 'AllergyIntolerance' | 'Condition' | 'Immunization' | 'Subscription' | 'SubscriptionTopic' | 'ChargeItemDefinition' | 'ServiceRequest' | 'Medication' | 'MedicationRequest' | 'Questionnaire' | 'QuestionnaireResponse' | 'Observation' | 'Binary' | 'Bundle' | 'OperationOutcome' | 'Parameters' | 'List' | 'null', nullable — The type of resource being referenced
      - `id` string, nullable — ID of the FHIR element (optional)
    - `valueInt` integer, nullable
    - `resource` AbstractFhirResource
      - `id` string, nullable — Logical id of this artifact
      - `meta` FhirResourceMeta
        - `lastUpdated` string, date-time, nullable — When the resource version last changed
        - `profile` string[] — Profiles this resource claims to conform to
      - `resourceType` string, nullable — Resource Type
    - `id` string, nullable — ID of the FHIR element (optional)
  - `text` FhirNarrative
    - `status` 'generated' | 'extensions' | 'additional' | 'empty' — Describes how the narrative was generated
    - `div` string — Limited xhtml content
    - `id` string, nullable — ID of the FHIR element (optional)
  - `contained` AbstractFhirResource[] — Contained, inline Resources
    - `id` string, nullable — Logical id of this artifact
    - `meta` FhirResourceMeta
      - `lastUpdated` string, date-time, nullable — When the resource version last changed
      - `profile` string[] — Profiles this resource claims to conform to
    - `resourceType` string, nullable — Resource Type
  - `meta` FhirResourceMeta
    - `lastUpdated` string, date-time, nullable — When the resource version last changed
    - `profile` string[] — Profiles this resource claims to conform to

## Other responses

- `403` — Forbidden
- `404` — Resource not found

---

[API](https://skmtc.dev/halaxy/apis/halaxy-api.md) · [All operations](https://skmtc.dev/halaxy/apis/halaxy-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/halaxy/halaxy-api/revisions/d72139daaa89/schema)