Skip to main content

Introduction

The section contains a complete documentation of Fire Arrow's GraphQL schema. The GraphQL schema follows the HL7 FHIR GraphQL schema specification. Since all types are generated directly from the official XML schema definition, the type documentation replicates the HL7 FHIR data model.

Fire Arrow only replicates the complete documentation on the GraphQL objects. Input types have annotated fields, whereas queries and mutations have no additional documentation because the CRUDS scheme they offer to interact with any type is self-explanatory.

To browse the schema efficiently, look at the content in Types -> Objects first. (example: Patient)

Assuming a client wants to create a resource of type Patient, the following queries and mutations exist:

  • Query Patient: Retrieves a single resource by id
  • Query PatientList: Searches for limited amount of patients (on Microsoft's implementation a maximum of 1000 entities)
  • Query PatientConnection: Cursored search over all patient resources
  • Mutation PatientCreate: Creates a patient resource
  • Mutation PatientUpdate: Updates a patient resource
  • Mutation PatientDelete: Deletes a patient resource

The same query and mutation naming scheme exists for all FHIR resource types.