Jump to Content

Product Guide API Reference Changelog

Product Guide API Reference Changelog

Overview

General

Developer Resources

Postman
Using the "Try it" Editor

Auth Service APIs

AppClient
Role
- List all rolesget
- Get role detailsget
User
Token Exchange
- Token Exchangepost
Token Proxy
- Token Proxypost

ZAP Data Subscriptions

EnrollmentStatuses
Packages
- List all available packagesget
- Retrieve details for a specific package.get

Patient History API

Patient History Retrieval

FHIR APIs

FHIR REST APIs (Preview)

Account
- Search for Account resourcesget
- Get a Account by FHIR IDget
AdverseEvent
- Search for AdverseEvent resourcesget
- Get a AdverseEvent by FHIR IDget
AllergyIntolerance
- Search for AllergyIntolerance resourcesget
- Get a AllergyIntolerance by FHIR IDget
Appointment
- Search for Appointment resourcesget
- Get a Appointment by FHIR IDget
AppointmentResponse
- Search for AppointmentResponse resourcesget
- Get a AppointmentResponse by FHIR IDget
Basic
- Search for Basic resourcesget
- Get a Basic by FHIR IDget
Binary
- Search for Binary resourcesget
- Get a Binary by FHIR IDget
BodyStructure
- Search for BodyStructure resourcesget
- Get a BodyStructure by FHIR IDget
CarePlan
- Search for CarePlan resourcesget
- Get a CarePlan by FHIR IDget
CareTeam
- Search for CareTeam resourcesget
- Get a CareTeam by FHIR IDget
ChargeItem
- Search for ChargeItem resourcesget
- Get a ChargeItem by FHIR IDget
Claim
- Search for Claim resourcesget
- Get a Claim by FHIR IDget
ClaimResponse
- Search for ClaimResponse resourcesget
- Get a ClaimResponse by FHIR IDget
ClinicalImpression
- Search for ClinicalImpression resourcesget
- Get a ClinicalImpression by FHIR IDget
Communication
- Search for Communication resourcesget
- Get a Communication by FHIR IDget
CommunicationRequest
- Search for CommunicationRequest resourcesget
- Get a CommunicationRequest by FHIR IDget
Composition
- Search for Composition resourcesget
- Get a Composition by FHIR IDget
Condition
- Search for Condition resourcesget
- Get a Condition by FHIR IDget
Consent
- Search for Consent resourcesget
- Get a Consent by FHIR IDget
Coverage
- Search for Coverage resourcesget
- Get a Coverage by FHIR IDget
CoverageEligibilityRequest
- Search for CoverageEligibilityRequest resourcesget
- Get a CoverageEligibilityRequest by FHIR IDget
CoverageEligibilityResponse
- Search for CoverageEligibilityResponse resourcesget
- Get a CoverageEligibilityResponse by FHIR IDget
DetectedIssue
- Search for DetectedIssue resourcesget
- Get a DetectedIssue by FHIR IDget
Device
- Search for Device resourcesget
- Get a Device by FHIR IDget
DeviceRequest
- Search for DeviceRequest resourcesget
- Get a DeviceRequest by FHIR IDget
DeviceUseStatement
- Search for DeviceUseStatement resourcesget
- Get a DeviceUseStatement by FHIR IDget
DiagnosticReport
- Search for DiagnosticReport resourcesget
- Get a DiagnosticReport by FHIR IDget
DocumentManifest
- Search for DocumentManifest resourcesget
- Get a DocumentManifest by FHIR IDget
DocumentReference
- Search for DocumentReference resourcesget
- Get a DocumentReference by FHIR IDget
Encounter
- Search for Encounter resourcesget
- Get a Encounter by FHIR IDget
EnrollmentRequest
- Search for EnrollmentRequest resourcesget
- Get a EnrollmentRequest by FHIR IDget
EpisodeOfCare
- Search for EpisodeOfCare resourcesget
- Get a EpisodeOfCare by FHIR IDget
ExplanationOfBenefit
- Search for ExplanationOfBenefit resourcesget
- Get a ExplanationOfBenefit by FHIR IDget
FamilyMemberHistory
- Search for FamilyMemberHistory resourcesget
- Get a FamilyMemberHistory by FHIR IDget
Flag
- Search for Flag resourcesget
- Get a Flag by FHIR IDget
Goal
- Search for Goal resourcesget
- Get a Goal by FHIR IDget
Group
- Search for Group resourcesget
- Get a Group by FHIR IDget
ImagingStudy
- Search for ImagingStudy resourcesget
- Get a ImagingStudy by FHIR IDget
Immunization
- Search for Immunization resourcesget
- Get a Immunization by FHIR IDget
ImmunizationEvaluation
- Search for ImmunizationEvaluation resourcesget
- Get a ImmunizationEvaluation by FHIR IDget
ImmunizationRecommendation
- Search for ImmunizationRecommendation resourcesget
- Get a ImmunizationRecommendation by FHIR IDget
Invoice
- Search for Invoice resourcesget
- Get a Invoice by FHIR IDget
List
- Search for List resourcesget
- Get a List by FHIR IDget
Location
- Search for Location resourcesget
- Get a Location by FHIR IDget
MeasureReport
- Search for MeasureReport resourcesget
- Get a MeasureReport by FHIR IDget
Media
- Search for Media resourcesget
- Get a Media by FHIR IDget
MedicationAdministration
- Search for MedicationAdministration resourcesget
- Get a MedicationAdministration by FHIR IDget
MedicationDispense
- Search for MedicationDispense resourcesget
- Get a MedicationDispense by FHIR IDget
MedicationRequest
- Search for MedicationRequest resourcesget
- Get a MedicationRequest by FHIR IDget
MedicationStatement
- Search for MedicationStatement resourcesget
- Get a MedicationStatement by FHIR IDget
MolecularSequence
- Search for MolecularSequence resourcesget
- Get a MolecularSequence by FHIR IDget
NutritionOrder
- Search for NutritionOrder resourcesget
- Get a NutritionOrder by FHIR IDget
Observation
- Search for Observation resourcesget
- Get a Observation by FHIR IDget
Organization
- Search for Organization resourcesget
- Get a Organization by FHIR IDget
Patient
- Search for Patient resourcesget
- Get a Patient by FHIR IDget
Person
- Search for Person resourcesget
- Get a Person by FHIR IDget
Practitioner
- Search for Practitioner resourcesget
- Get a Practitioner by FHIR IDget
Procedure
- Search for Procedure resourcesget
- Get a Procedure by FHIR IDget
Provenance
- Search for Provenance resourcesget
- Get a Provenance by FHIR IDget
QuestionnaireResponse
- Search for QuestionnaireResponse resourcesget
- Get a QuestionnaireResponse by FHIR IDget
RelatedPerson
- Search for RelatedPerson resourcesget
- Get a RelatedPerson by FHIR IDget
RequestGroup
- Search for RequestGroup resourcesget
- Get a RequestGroup by FHIR IDget
ResearchSubject
- Search for ResearchSubject resourcesget
- Get a ResearchSubject by FHIR IDget
RiskAssessment
- Search for RiskAssessment resourcesget
- Get a RiskAssessment by FHIR IDget
Schedule
- Search for Schedule resourcesget
- Get a Schedule by FHIR IDget
ServiceRequest
- Search for ServiceRequest resourcesget
- Get a ServiceRequest by FHIR IDget
Specimen
- Search for Specimen resourcesget
- Get a Specimen by FHIR IDget
SupplyDelivery
- Search for SupplyDelivery resourcesget
- Get a SupplyDelivery by FHIR IDget
SupplyRequest
- Search for SupplyRequest resourcesget
- Get a SupplyRequest by FHIR IDget
VisionPrescription
- Search for VisionPrescription resourcesget
- Get a VisionPrescription by FHIR IDget

Overview

General

Developer Resources

Postman
Using the "Try it" Editor

Auth Service APIs

AppClient
Role
- List all rolesget
- Get role detailsget
User
Token Exchange
- Token Exchangepost
Token Proxy
- Token Proxypost

ZAP Data Subscriptions

EnrollmentStatuses
Packages
- List all available packagesget
- Retrieve details for a specific package.get

Patient History API

Patient History Retrieval

FHIR APIs

FHIR REST APIs (Preview)

Account
- Search for Account resourcesget
- Get a Account by FHIR IDget
AdverseEvent
- Search for AdverseEvent resourcesget
- Get a AdverseEvent by FHIR IDget
AllergyIntolerance
- Search for AllergyIntolerance resourcesget
- Get a AllergyIntolerance by FHIR IDget
Appointment
- Search for Appointment resourcesget
- Get a Appointment by FHIR IDget
AppointmentResponse
- Search for AppointmentResponse resourcesget
- Get a AppointmentResponse by FHIR IDget
Basic
- Search for Basic resourcesget
- Get a Basic by FHIR IDget
Binary
- Search for Binary resourcesget
- Get a Binary by FHIR IDget
BodyStructure
- Search for BodyStructure resourcesget
- Get a BodyStructure by FHIR IDget
CarePlan
- Search for CarePlan resourcesget
- Get a CarePlan by FHIR IDget
CareTeam
- Search for CareTeam resourcesget
- Get a CareTeam by FHIR IDget
ChargeItem
- Search for ChargeItem resourcesget
- Get a ChargeItem by FHIR IDget
Claim
- Search for Claim resourcesget
- Get a Claim by FHIR IDget
ClaimResponse
- Search for ClaimResponse resourcesget
- Get a ClaimResponse by FHIR IDget
ClinicalImpression
- Search for ClinicalImpression resourcesget
- Get a ClinicalImpression by FHIR IDget
Communication
- Search for Communication resourcesget
- Get a Communication by FHIR IDget
CommunicationRequest
- Search for CommunicationRequest resourcesget
- Get a CommunicationRequest by FHIR IDget
Composition
- Search for Composition resourcesget
- Get a Composition by FHIR IDget
Condition
- Search for Condition resourcesget
- Get a Condition by FHIR IDget
Consent
- Search for Consent resourcesget
- Get a Consent by FHIR IDget
Coverage
- Search for Coverage resourcesget
- Get a Coverage by FHIR IDget
CoverageEligibilityRequest
- Search for CoverageEligibilityRequest resourcesget
- Get a CoverageEligibilityRequest by FHIR IDget
CoverageEligibilityResponse
- Search for CoverageEligibilityResponse resourcesget
- Get a CoverageEligibilityResponse by FHIR IDget
DetectedIssue
- Search for DetectedIssue resourcesget
- Get a DetectedIssue by FHIR IDget
Device
- Search for Device resourcesget
- Get a Device by FHIR IDget
DeviceRequest
- Search for DeviceRequest resourcesget
- Get a DeviceRequest by FHIR IDget
DeviceUseStatement
- Search for DeviceUseStatement resourcesget
- Get a DeviceUseStatement by FHIR IDget
DiagnosticReport
- Search for DiagnosticReport resourcesget
- Get a DiagnosticReport by FHIR IDget
DocumentManifest
- Search for DocumentManifest resourcesget
- Get a DocumentManifest by FHIR IDget
DocumentReference
- Search for DocumentReference resourcesget
- Get a DocumentReference by FHIR IDget
Encounter
- Search for Encounter resourcesget
- Get a Encounter by FHIR IDget
EnrollmentRequest
- Search for EnrollmentRequest resourcesget
- Get a EnrollmentRequest by FHIR IDget
EpisodeOfCare
- Search for EpisodeOfCare resourcesget
- Get a EpisodeOfCare by FHIR IDget
ExplanationOfBenefit
- Search for ExplanationOfBenefit resourcesget
- Get a ExplanationOfBenefit by FHIR IDget
FamilyMemberHistory
- Search for FamilyMemberHistory resourcesget
- Get a FamilyMemberHistory by FHIR IDget
Flag
- Search for Flag resourcesget
- Get a Flag by FHIR IDget
Goal
- Search for Goal resourcesget
- Get a Goal by FHIR IDget
Group
- Search for Group resourcesget
- Get a Group by FHIR IDget
ImagingStudy
- Search for ImagingStudy resourcesget
- Get a ImagingStudy by FHIR IDget
Immunization
- Search for Immunization resourcesget
- Get a Immunization by FHIR IDget
ImmunizationEvaluation
- Search for ImmunizationEvaluation resourcesget
- Get a ImmunizationEvaluation by FHIR IDget
ImmunizationRecommendation
- Search for ImmunizationRecommendation resourcesget
- Get a ImmunizationRecommendation by FHIR IDget
Invoice
- Search for Invoice resourcesget
- Get a Invoice by FHIR IDget
List
- Search for List resourcesget
- Get a List by FHIR IDget
Location
- Search for Location resourcesget
- Get a Location by FHIR IDget
MeasureReport
- Search for MeasureReport resourcesget
- Get a MeasureReport by FHIR IDget
Media
- Search for Media resourcesget
- Get a Media by FHIR IDget
MedicationAdministration
- Search for MedicationAdministration resourcesget
- Get a MedicationAdministration by FHIR IDget
MedicationDispense
- Search for MedicationDispense resourcesget
- Get a MedicationDispense by FHIR IDget
MedicationRequest
- Search for MedicationRequest resourcesget
- Get a MedicationRequest by FHIR IDget
MedicationStatement
- Search for MedicationStatement resourcesget
- Get a MedicationStatement by FHIR IDget
MolecularSequence
- Search for MolecularSequence resourcesget
- Get a MolecularSequence by FHIR IDget
NutritionOrder
- Search for NutritionOrder resourcesget
- Get a NutritionOrder by FHIR IDget
Observation
- Search for Observation resourcesget
- Get a Observation by FHIR IDget
Organization
- Search for Organization resourcesget
- Get a Organization by FHIR IDget
Patient
- Search for Patient resourcesget
- Get a Patient by FHIR IDget
Person
- Search for Person resourcesget
- Get a Person by FHIR IDget
Practitioner
- Search for Practitioner resourcesget
- Get a Practitioner by FHIR IDget
Procedure
- Search for Procedure resourcesget
- Get a Procedure by FHIR IDget
Provenance
- Search for Provenance resourcesget
- Get a Provenance by FHIR IDget
QuestionnaireResponse
- Search for QuestionnaireResponse resourcesget
- Get a QuestionnaireResponse by FHIR IDget
RelatedPerson
- Search for RelatedPerson resourcesget
- Get a RelatedPerson by FHIR IDget
RequestGroup
- Search for RequestGroup resourcesget
- Get a RequestGroup by FHIR IDget
ResearchSubject
- Search for ResearchSubject resourcesget
- Get a ResearchSubject by FHIR IDget
RiskAssessment
- Search for RiskAssessment resourcesget
- Get a RiskAssessment by FHIR IDget
Schedule
- Search for Schedule resourcesget
- Get a Schedule by FHIR IDget
ServiceRequest
- Search for ServiceRequest resourcesget
- Get a ServiceRequest by FHIR IDget
Specimen
- Search for Specimen resourcesget
- Get a Specimen by FHIR IDget
SupplyDelivery
- Search for SupplyDelivery resourcesget
- Get a SupplyDelivery by FHIR IDget
SupplyRequest
- Search for SupplyRequest resourcesget
- Get a SupplyRequest by FHIR IDget
VisionPrescription
- Search for VisionPrescription resourcesget
- Get a VisionPrescription by FHIR IDget

Perform PATCH update on Organization instance

patch https://api.sandbox.zusapi.com/fhir/Organization/{id}

Language

Click Try It! to start a request and see the response here!