OnyeOne Documentation
    OnyeOne Documentation
    • Overview
    • OnyeOne Use Cases
    • Authentication
    • Guides
      • OnyeOne Request Flow
    • Core EHR/EMR FHIR R4 APIs
      • Administration
        • Patients
          • Create Patient Resource
          • Update Patient Resource
        • Practitioners
          • Create Practitioner Resource
          • Update Practitioner Resource
          • Create Practitioner Role
          • Update PractitionerRole Resource
        • Locations
          • Create a Location Resource
          • Update Location Resource
        • Health Service
          • Create Health Service Resource
          • Update Health Service Resource
        • Encounters
          • Create Encounter Resource
          • Update Encounter Resource
        • Appointments
          • Create Appointment Resource
          • Update Appointment Resource
        • Group
      • Clinical
        • AllergyIntolerance
        • Condition (Problem)
        • Procedure
        • FamilyMemberHistory
        • CarePlan
        • Goal
        • CareTeam
        • ClinicalImpression
        • AdverseEvent
        • DetectedIssue
        • RiskAssessment
      • Diagnostics
        • Observation
          • Create Observation Resource
        • DiagnosticReport
        • ServiceRequest
        • Media
        • ImagingStudy
        • MolecularSequence
        • Specimen
        • BodyStructure
      • Medications
        • MedicationRequest
        • MedicationDispense
        • MedicationAdministration
        • MedicationStatement
        • Medication
        • MedicationKnowledge
        • Immunization
        • ImmunizationEvaluation
        • ImmunizationRecommendation
      • Financial
        • Account
        • Contract
        • Coverage
        • CoverageEligibilityRequest
        • CoverageEligibilityResponse
        • EnrollmentRequest
        • EnrollmentResponse
        • Claim
        • ClaimResponse
        • PaymentNotice
        • PaymentReconciliation
        • ExplanationOfBenefit
        • VisionPrescription
    • Health Data Transformation
      • Transfrom HL7v2 to FHIR R4
        POST
      • Transform CCDA to FHIR R4
        POST
      • Transform HL7v2 to FHIR R4 and Store in Backend Database
        POST
      • Track API Request
        GET
    • Health Interoperabilty System
      • Create a Subscription
        POST
    • Webhook
    • Get Resource.
      GET

    Authentication

    OnyeOne Logo
    The API uses an x-api-key header for authentication. Each request must include a valid API key to access the endpoints.
    Headers:
    x-api-key: Your unique API key.
    Base URLs:
    staging: https://staging.onyeone.com/api
    production: https://onyeone.com/api
    Example Request:

    Error Responses#

    CodeMessageDescription
    401UnauthorizedMissing or invalid API key.
    403ForbiddenAPI key does not have required permissions.
    To obtain your API key, contact the administrator or refer to the Developer Portal.
    Previous
    OnyeOne Use Cases
    Next
    OnyeOne Request Flow
    Built with