Developer Portal
  • Getting Started
  • API Reference
  • Guides
  • Support
Search
K
HAPI FHIR Server
5.4.0
  • Overview
      • server-capabilities: Fetch the server FHIR CapabilityStatementget
      • /$exportget
      • Obtain OAuth Tokenpost
      • Get the change logs in the FHIR APIget
      • read-type: Read a new AllergyIntolerance instanceget
      • update-type: Update a new AllergyIntolerance instanceput
      • delete-type: Delete a new AllergyIntolerance instancedelete
      • search-type: Search a new AllergyIntolerance instanceget
      • create-type: Create a new AllergyIntolerance instancepost
      • read-instance: Read Bundle instanceget
      • update-instance: Update an existing Bundle instance, or create using a client-assigned IDput
      • search-type: Update an existing Bundle instance, or create using a client-assigned IDget
      • create-type: Create a new Bundle instancepost
      • /Bundle/$qhinMessageDeliveryget
      • read-instance: Read CarePlan instanceget
      • update-instance: Update an existing CarePlan instance, or create using a client-assigned IDput
      • instance-delete: Perform a logical delete on a resource instancedelete
      • search-type: Update an existing CarePlan instance, or create using a client-assigned IDget
      • create-type: Create a new CarePlan instancepost
      • read-instance: Read CodeSystem instanceget
      • /CodeSystem/$lookupget
      • read-instance: Read Composition instanceget
      • search-type: Update an existing Composition instance, or create using a client-assigned IDget
      • /Composition/{id}/$documentget
      • read-instance: Read Condition instanceget
      • update-instance: Update an existing Condition instance, or create using a client-assigned IDput
      • instance-delete: Perform a logical delete on a resource instancedelete
      • search-type: Update an existing Condition instance, or create using a client-assigned IDget
      • create-type: Create a new Condition instancepost
      • read-instance: Read Consent instanceget
      • instance-delete: Perform a logical delete on a resource instancedelete
      • search-type: Update an existing Consent instance, or create using a client-assigned IDget
      • create-type: Create a new Consent instancepost
      • read-instance: Read Coverage instanceget
      • instance-delete: Perform a logical delete on a resource instancedelete
      • search-type: Update an existing Coverage instance, or create using a client-assigned IDget
      • create-type: Create a new Coverage instancepost
      • read-instance: Read DeviceUseStatement instanceget
      • update-instance: Update an existing DeviceUseStatement instance, or create using a client-assigned IDput
      • instance-delete: Perform a logical delete on a resource instancedelete
      • search-type: Update an existing DeviceUseStatement instance, or create using a client-assigned IDget
      • create-type: Create a new DeviceUseStatement instancepost
      • read-instance: Read DiagnosticReport instanceget
      • instance-delete: Perform a logical delete on a resource instancedelete
      • instance-patch: Patch a resource instance of type DiagnosticReport by IDpatch
      • search-type: Update an existing DiagnosticReport instance, or create using a client-assigned IDget
      • create-type: Create a new DiagnosticReport instancepost
      • /DiagnosticReport/{id}/$hl7get
      • /DiagnosticReport/{id}/$pdfget
      • read-instance: Read DirectMessage instanceget
      • search-type: Update an existing DirectMessage instance, or create using a client-assigned IDget
      • create-type: Create a new DirectMessage instancepost
      • /DirectMessage/$searchProvidersget
      • read-instance: Read DocumentReference instanceget
      • instance-delete: Perform a logical delete on a resource instancedelete
      • search-type: Update an existing DocumentReference instance, or create using a client-assigned IDget
      • create-type: Create a new DocumentReference instancepost
      • /DocumentReference/$cq-scanget
      • /DocumentReference/$cq-searchget
      • /DocumentReference/{id}/$cq-searchget
      • /DocumentReference/$cw-searchget
      • /DocumentReference/{id}/$cw-searchget
      • /DocumentReference/{id}/$pdfget
      • /DocumentReference/$ehex-scanget
      • /DocumentReference/$ehex-searchget
      • /DocumentReference/{id}/$ehex-searchget
      • /DocumentReference/$export-ccdaget
      • /DocumentReference/{id}/$export-ccdaget
      • /DocumentReference/$hghin-searchget
      • /DocumentReference/{id}/$hghin-searchget
      • /DocumentReference/{id}/$ocrget
      • /DocumentReference/$p360-retrieveget
      • /DocumentReference/$p360-searchget
      • /DocumentReference/$qhin-searchget
      • /DocumentReference/{id}/$qhin-searchget
      • read-instance: Read Encounter instanceget
      • update-instance: Update an existing Encounter instance, or create using a client-assigned IDput
      • instance-delete: Perform a logical delete on a resource instancedelete
      • search-type: Update an existing Encounter instance, or create using a client-assigned IDget
      • create-type: Create a new Encounter instancepost
      • /Encounter/{id}/$pdfget
      • read-instance: Read FamilyMemberHistory instanceget
      • update-instance: Update an existing FamilyMemberHistory instance, or create using a client-assigned IDput
      • instance-delete: Perform a logical delete on a resource instancedelete
      • search-type: Update an existing FamilyMemberHistory instance, or create using a client-assigned IDget
      • create-type: Create a new FamilyMemberHistory instancepost
      • read-instance: Read FaxMessage instanceget
      • search-type: Update an existing FaxMessage instance, or create using a client-assigned IDget
      • create-type: Create a new FaxMessage instancepost
      • read-instance: Read Goal instanceget
      • update-instance: Update an existing Goal instance, or create using a client-assigned IDput
      • instance-delete: Perform a logical delete on a resource instancedelete
      • search-type: Update an existing Goal instance, or create using a client-assigned IDget
      • create-type: Create a new Goal instancepost
      • read-instance: Read Group instanceget
      • update-instance: Update an existing Group instance, or create using a client-assigned IDput
      • instance-delete: Perform a logical delete on a resource instancedelete
      • search-type: Update an existing Group instance, or create using a client-assigned IDget
      • create-type: Create a new Group instancepost
      • /Group/{id}/$add-to-groupget
      • /Group/{id}/$everythingget
      • /Group/{id}/$membersget
      • /Group/{id}/$remove-from-groupget
      • read-instance: Read Immunization instanceget
      • update-instance: Update an existing Immunization instance, or create using a client-assigned IDput
      • instance-delete: Perform a logical delete on a resource instancedelete
      • search-type: Update an existing Immunization instance, or create using a client-assigned IDget
      • create-type: Create a new Immunization instancepost
      • read-instance: Read InstantMessage instanceget
      • search-type: Update an existing InstantMessage instance, or create using a client-assigned IDget
      • read-instance: Read List instanceget
      • search-type: Update an existing List instance, or create using a client-assigned IDget
      • read-instance: Read Location instanceget
      • search-type: Update an existing Location instance, or create using a client-assigned IDget
      • /Location/{id}/$requisition-settingsget
      • read-instance: Read MedicationDispense instanceget
      • update-instance: Update an existing MedicationDispense instance, or create using a client-assigned IDput
      • instance-delete: Perform a logical delete on a resource instancedelete
      • search-type: Update an existing MedicationDispense instance, or create using a client-assigned IDget
      • create-type: Create a new MedicationDispense instancepost
      • read-instance: Read MedicationRequest instanceget
      • update-instance: Update an existing MedicationRequest instance, or create using a client-assigned IDput
      • instance-delete: Perform a logical delete on a resource instancedelete
      • search-type: Update an existing MedicationRequest instance, or create using a client-assigned IDget
      • create-type: Create a new MedicationRequest instancepost
      • read-instance: Read MedicationStatement instanceget
      • update-instance: Update an existing MedicationStatement instance, or create using a client-assigned IDput
      • instance-delete: Perform a logical delete on a resource instancedelete
      • search-type: Update an existing MedicationStatement instance, or create using a client-assigned IDget
      • create-type: Create a new MedicationStatement instancepost
      • read-instance: Read NutritionOrder instanceget
      • update-instance: Update an existing NutritionOrder instance, or create using a client-assigned IDput
      • instance-delete: Perform a logical delete on a resource instancedelete
      • search-type: Update an existing NutritionOrder instance, or create using a client-assigned IDget
      • create-type: Create a new NutritionOrder instancepost
      • read-instance: Read Observation instanceget
      • update-instance: Update an existing Observation instance, or create using a client-assigned IDput
      • instance-delete: Perform a logical delete on a resource instancedelete
      • search-type: Update an existing Observation instance, or create using a client-assigned IDget
      • create-type: Create a new Observation instancepost
      • read-instance: Read OperationDefinition instanceget
      • read-instance: Read Organization instanceget
      • update-instance: Update an existing Organization instance, or create using a client-assigned IDput
      • instance-delete: Perform a logical delete on a resource instancedelete
      • search-type: Update an existing Organization instance, or create using a client-assigned IDget
      • create-type: Create a new Organization instancepost
      • /Organization/{id}/$remove-subtenantget
      • /Organization/{id}/$requisition-settingsget
      • read-instance: Read Patient instanceget
      • update-instance: Update an existing Patient instance, or create using a client-assigned IDput
      • search-type: Update an existing Patient instance, or create using a client-assigned IDget
      • create-type: Create a new Patient instancepost
      • /Patient/$cq-searchget
      • /Patient/{id}/$cq-searchget
      • /Patient/{id}/$cw-enrollget
      • /Patient/{id}/$cw-lookupget
      • /Patient/{id}/$cw-matchget
      • /Patient/$cw-searchget
      • /Patient/{id}/$cw-searchget
      • /Patient/{id}/$cw-unenrollget
      • /Patient/$ehex-searchget
      • /Patient/{id}/$ehex-searchget
      • /Patient/{id}/$enabledForSharingget
      • /Patient/{id}/$enrollForUpdatesget
      • /Patient/{id}/$everythingget
      • /Patient/$export-ccdaget
      • /Patient/{id}/$export-ccdaget
      • /Patient/$hghin-searchget
      • /Patient/{id}/$hghin-searchget
      • /Patient/{id}/$init-chartbridge-enrollmentget
      • /Patient/{id}/$init-epic-flowget
      • /Patient/$mergepost
      • /Patient/$qhin-searchget
      • /Patient/{id}/$qhin-searchget
      • /Patient/{id}/$facility-patient-cw-unenrollpost
      • /Patient/{id}/$patient-enroll-retrieve-docsget
      • /Patient/{id}/$patient-enroll-import-docspost
      • /Patient/{id}/$retrieve-documentget
      • /Patient/{id}/$patient-import-docpost
      • /Patient/{id}/$update-external-ial2post
      • /Patient/{id}/$updateExternalIdentityVerificationpost
      • read-instance: Read Person instanceget
      • read-instance: Read Practitioner instanceget
      • search-type: Update an existing Practitioner instance, or create using a client-assigned IDget
      • read-instance: Read PractitionerRole instanceget
      • update-instance: Update an existing PractitionerRole instance, or create using a client-assigned IDput
      • search-type: Update an existing PractitionerRole instance, or create using a client-assigned IDget
      • create-type: Create a new PractitionerRole instancepost
      • /PractitionerRole/{id}/$addSignaturepost
      • /PractitionerRole/{id}/$signaturesget
      • /PractitionerRole/{id}/$removeSignatureget
      • read-instance: Read Procedure instanceget
      • update-instance: Update an existing Procedure instance, or create using a client-assigned IDput
      • instance-delete: Perform a logical delete on a resource instancedelete
      • search-type: Update an existing Procedure instance, or create using a client-assigned IDget
      • create-type: Create a new Procedure instancepost
      • read-instance: Read Provenance instanceget
      • read-instance: Read Questionnaire instanceget
      • search-type: Update an existing Questionnaire instance, or create using a client-assigned IDget
      • /Questionnaire/$procedurespost
      • /Questionnaire/{id}/$procedurespost
      • /Questionnaire/$populatepost
      • /Questionnaire/{id}/$populatepost
      • read-instance: Read RequestGroup instanceget
      • instance-patch: Patch a resource instance of type RequestGroup by IDpatch
      • search-type: Update an existing RequestGroup instance, or create using a client-assigned IDget
      • create-type: Create a new RequestGroup instancepost
      • /RequestGroup/$abnpost
      • /RequestGroup/{id}/$abnpost
      • /RequestGroup/{id}/$labelget
      • /RequestGroup/{id}/$pdfget
      • /RequestGroup/{id}/$submitget
      • type-history: Fetch the resource change history for all resources of type RiskAssessmentget
      • instance-history: Fetch the resource change history for all resources of type RiskAssessmentget
      • search-type: Update an existing RiskAssessment instance, or create using a client-assigned IDget
      • read-instance: Read ServiceRequest instanceget
      • search-type: Update an existing ServiceRequest instance, or create using a client-assigned IDget
      • create-type: Create a new ServiceRequest instancepost
      • /ServiceRequest/{id}/$pdfget
      • read-instance: Read StructureDefinition instanceget
      • search-type: Update an existing StructureDefinition instance, or create using a client-assigned IDget
      • read-instance: Read Subscription instanceget
      • instance-delete: Perform a logical delete on a resource instancedelete
      • instance-patch: Patch a resource instance of type Subscription by IDpatch
      • search-type: Update an existing Subscription instance, or create using a client-assigned IDget
      • create-type: Create a new Subscription instancepost
      • read-instance: Read User instanceget
      • update-instance: Update an existing User instance, or create using a client-assigned IDput
      • search-type: Update an existing User instance, or create using a client-assigned IDget
      • create-type: Create a new User instancepost
      • read-instance: Read ValueSet instanceget
      • /ValueSet/{id}/$expandget
      • /ValueSet/$searchget
HAPI FHIR Server
Developer Portal
Products
  • Infrastructure
  • Lab Data
  • EHR Data
  • ADT Data
Company
  • About
  • Careers
  • News
  • Blog
Legal
  • Terms of use
  • Privacy policy