openapi: 3.0.3
info:
  title: 'Aurabox API Documentation'
  description: ''
  version: 1.0.0
servers:
  -
    url: 'https://region.aurabox.cloud/api/v1'
paths:
  '/api/v1/patient/{id}':
    get:
      summary: 'Retrieve a patient'
      operationId: retrieveAPatient
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: some-uuid
                  given_names: Jessica
                  family_name: Jones
                  date_of_birth: '1985-06-15'
                  sex: female
                  address:
                    street: '123 Main Street'
                    city: Sydney
                    state: NSW
                    postcode: '2000'
                    country: au
                properties:
                  id:
                    type: string
                    example: some-uuid
                  given_names:
                    type: string
                    example: Jessica
                  family_name:
                    type: string
                    example: Jones
                  date_of_birth:
                    type: string
                    example: '1985-06-15'
                  sex:
                    type: string
                    example: female
                  address:
                    type: object
                    properties:
                      street:
                        type: string
                        example: '123 Main Street'
                      city:
                        type: string
                        example: Sydney
                      state:
                        type: string
                        example: NSW
                      postcode:
                        type: string
                        example: '2000'
                      country:
                        type: string
                        example: au
      tags:
        - Patients
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the patient.'
        example: 003fb6c7-a399-46de-8199-ac51e031bd10
        required: true
        schema:
          type: string
  /api/v1/patient:
    post:
      summary: 'Create a patient record on the current team'
      operationId: createAPatientRecordOnTheCurrentTeam
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  result: success
                  patient: some-uuid
                properties:
                  result:
                    type: string
                    example: success
                  patient:
                    type: string
                    example: some-uuid
      tags:
        - Patients
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                given_names:
                  type: string
                  description: "The patient's given names."
                  example: John
                  nullable: false
                family_name:
                  type: string
                  description: "The patient's family names."
                  example: Smith
                  nullable: false
                date_of_birth:
                  type: string
                  description: "The patient's date of birth in ISO 8601 format (YYYY-MM-DD)."
                  example: '1985-06-15'
                  nullable: false
                sex:
                  type: string
                  description: "The patient's sex, typically 'male', 'female', or 'other'."
                  example: male
                  nullable: false
                address:
                  type: object
                  description: ''
                  example:
                    street: '123 Main Street'
                  nullable: false
                  properties:
                    street:
                      type: string
                      description: "The patient's street address."
                      example: '123 Main Street'
                      nullable: false
                    city:
                      type: string
                      description: "The city of the patient's address."
                      example: Sydney
                      nullable: false
                    state:
                      type: string
                      description: "The state or province of the patient's address."
                      example: NSW
                      nullable: false
                    postcode:
                      type: string
                      description: "The postcode of the patient's address."
                      example: '2000'
                      nullable: false
                    country:
                      type: string
                      description: "The country of the patient's address."
                      example: Australia
                      nullable: false
              required:
                - given_names
                - family_name
                - date_of_birth
                - sex
tags:
  -
    name: Patients
    description: 'APIs for managing patients'
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: 'You can retrieve your token by visiting your dashboard and clicking <b>Generate API token</b>.'
security:
  -
    default: []
