> ## Documentation Index
> Fetch the complete documentation index at: https://docs.splose.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a single patient

> Create a single patient



## OpenAPI

````yaml post /patients
openapi: 3.0.0
info:
  version: 1.0.0
  title: splose public API
  description: "\nWelcome to the splose API documentation. splose serves as a comprehensive Allied Health & NDIS practice management software designed to streamline administrative tasks and foster the growth of your practice.\n\n# Introduction\nThe splose API follows a REST architectural style, offering JSON-encoded responses, standard HTTP response codes, easily understandable resource-oriented URLs, and robust authentication mechanisms.\n\n# Authentication\n### API Key Authentication\nThe splose API employs API keys for request authentication. Workspace owners can apply for and manage API keys through the splose dashboard. It's crucial to safeguard the API key, as it grants the same permissions as the associated user.\n\n### Bearer Authentication\nAuthentication for API access is achieved via Bearer Authentication. Include the API key in the request header using the format: `Authorization: Bearer your_api_key`.\n\n### Secure Communication\nAll API requests must be conducted over HTTPS. Requests made over plain HTTP will not succeed. Additionally, unauthenticated API requests will result in failure.\n\n# Rate limit\nThere are limits to the number of API calls that your application can make with one API key.\n\n+ Minute Limit: 60 calls per minute\n\n# Error\nsplose uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. \nCodes in the 4xx range indicate an error that failed given the information provided. Codes in the 5xx range indicate an error with splose's servers.\n\nError types:\n+ 400 - Bad request: the request failed due to missing or invalid parameters.\n+ 401 - Unauthorized: No valid API key provided.\n+ 404 - Not Found: \tThe requested resource doesn't exist.\n+ 429 - Too Many Requests: Too many requests hit the API too quickly.\n+ 500 - Internal Server Error : Something went wrong on splose's end.\n\n# Datetime\nAll datetime values provided in request parameters and responses are in Coordinated Universal Time (UTC). The accepted datetime formats are outlined below:\n+ 2023-07-01\n+ 2023-07-01T00:00:00Z\n+ 2023-07-01T00:00:00.000Z\n\n# Pagination\n\n### Pagination for Multiple Objects\nFor endpoints returning multiple objects, pagination is in place to manage response sizes. Each response is limited to a certain number of objects. \nAdditionally, the response includes a `links` field that provides URLs for fetching the next and/or previous pages, if applicable.\n\n### Manual Positioning\nYou have the option to manually specify the `id_gt` or `id_lt` value as a request parameter. This allows you to retrieve objects starting from a specific position. If neither of these values is provided, the initial page of objects will be returned by default.\n+ `id_gt`: Request for next page of objects with id greater than the specified value. \n+ `id_lt`: Request for previous page of objects with id less than the specified value. \n\n# Realtime feed\nCertain users may require real-time data retrieval. Given the substantial data volume, retrieving the complete dataset may not be efficient. To address this, we offer the option to retrieve data based on its update timestamp. This approach necessitates fetching the entire dataset only during the initial request. Subsequent retrievals involve fetching solely the modified data to replace outdated information.\n+ `update_gt`: Request for objects updated after the specified datetime. \n+ `update_lt`: Request for objects updated before the specified datetime. \n\n# Change log\n+ 2024-04-10: add payment method and payment endpoints\n+ 2024-02-28: add availability endpoint\n"
  contact:
    email: support@splose.com
servers:
  - url: https://api.splose.com/v1
security: []
externalDocs:
  description: Find out more about splose
  url: https://splose.com
paths:
  /patients:
    post:
      tags:
        - patient
      summary: Create a single patient
      description: Create a single patient
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                firstname:
                  type: string
                  description: Patient first name
                  example: Harry
                lastname:
                  type: string
                  description: Patient last name
                  example: Potter
                middleName:
                  type: string
                  nullable: true
                  description: Patient middle name
                  example: James
                preferredName:
                  type: string
                  nullable: true
                  description: Patient preferred name
                  example: Harry
                title:
                  type: string
                  nullable: true
                  description: Patient title
                  example: Mr.
                email:
                  type: string
                  nullable: true
                  description: Patient email
                  example: harry@hogwarts.edu
                sex:
                  type: string
                  nullable: true
                  description: Patient sex
                  example: Male
                genderIdentity:
                  type: string
                  nullable: true
                  description: Patient gender identity
                  example: Man
                pronouns:
                  type: string
                  nullable: true
                  description: Patient pronouns
                  example: They/them
                alert:
                  type: string
                  nullable: true
                  description: Patient alert messages
                  example: He knows magic
                invoiceRecipientId:
                  type: integer
                  nullable: true
                  minimum: 0
                  exclusiveMinimum: true
                  description: The invoice receipient (contact) id of this patient
                  example: 1
                birthdate:
                  anyOf:
                    - type: string
                    - type: string
                    - nullable: true
                  description: Patient birthdate in YYYY-MM-DD format
                  example: '1996-07-30T00:00:00.000Z'
                timezone:
                  type: string
                  nullable: true
                  description: Patient timezone
                  example: Australia/Adelaide
                extraInfo:
                  type: string
                  nullable: true
                  description: Patient extra info
                  example: Some extra info
                extraBillingInfo:
                  type: string
                  nullable: true
                  description: Patient extra billing info
                  example: Some extra billing info
                addressL1:
                  type: string
                  nullable: true
                  description: Patient address line 1
                  example: 123 King William Street
                addressL2:
                  type: string
                  nullable: true
                  description: Patient address line 2
                  example: ''
                addressL3:
                  type: string
                  nullable: true
                  description: Patient address line 3
                  example: ''
                city:
                  type: string
                  nullable: true
                  description: Patient city
                  example: Adelaide
                state:
                  type: string
                  nullable: true
                  description: Patient state
                  example: SA
                postalCode:
                  type: string
                  nullable: true
                  description: Patient post code
                  example: '5000'
                country:
                  type: string
                  nullable: true
                  description: Patient country
                  example: Australia
                phoneNumbers:
                  type: array
                  nullable: true
                  items:
                    type: object
                    properties:
                      type:
                        type: string
                        nullable: true
                        enum:
                          - Mobile
                          - Home
                          - Work
                          - Fax
                          - Other
                        description: Phone number type
                        example: Mobile
                      code:
                        type: string
                        nullable: true
                        description: Phone country code
                        example: '+61'
                      phoneNumber:
                        type: string
                        description: Phone number
                        example: '401234567'
                    required:
                      - phoneNumber
                privacyPolicy:
                  type: string
                  nullable: true
                  enum:
                    - No response
                    - Accepted
                    - Rejected
                    - ''
                  description: Patient privacy policy status
                  example: Accepted
                ndisNumber:
                  type: string
                  nullable: true
                  description: Patient NDIS number
                  example: '430123456'
                ndisInfo:
                  type: object
                  nullable: true
                  properties:
                    diagnosis:
                      type: string
                      nullable: true
                      description: NDIS Diagnosis
                      example: Foot Injury
                    nomineeEmail:
                      type: string
                      nullable: true
                      description: Nominee email
                      example: nominee@email.com
                    fundManagement:
                      type: string
                      nullable: true
                      description: NDIS fund management type
                      example: Plan-managed
                    nomineeLastName:
                      type: string
                      nullable: true
                      description: Last name of nominee
                      example: Clark
                    nomineeFirstName:
                      type: string
                      nullable: true
                      description: First name of nominee
                      example: Chris
                    nomineeMobileCode:
                      type: string
                      nullable: true
                      description: Nominee phone country code
                      example: '+61'
                    nomineeMobileNumber:
                      type: string
                      nullable: true
                      description: Nominee phone number
                      example: '433555111'
                    startDate:
                      type: string
                      nullable: true
                      description: Plan start date
                      example: '2024-02-09T00:00:00.000Z'
                    endDate:
                      type: string
                      nullable: true
                      description: Plan end date
                      example: '2024-02-18T00:00:00.000Z'
                medicareNum:
                  type: string
                  nullable: true
                  description: Patient Medicare number
                  example: '4444444444'
                irn:
                  type: string
                  nullable: true
                  description: Patient Medicare reference number
                  example: '1'
                veteransFileNumber:
                  type: string
                  nullable: true
                  description: Patient veterans information
                  example: ''
                emergencyContactNumber:
                  type: string
                  nullable: true
                  description: Patient emergency contact number
                  example: '0412345678'
                emergencyContactName:
                  type: string
                  nullable: true
                  description: Patient emergency contact name
                  example: Quentin Neely
                emergencyContactRelationship:
                  type: string
                  nullable: true
                  description: Patient emergency contact relationship
                  example: Brother
                communicationPreference:
                  type: string
                  enum:
                    - NONE
                    - SMS
                    - SMS_EMAIL
                    - EMAIL
                  description: >-
                    Patient communication preference (defaults to organisation's
                    communication preference if not set)
                  example: SMS
                archived:
                  type: boolean
                  nullable: true
                  default: false
                  description: Whether the patient has been archived
                createdAt:
                  anyOf:
                    - type: string
                    - type: string
                  description: Object creation date time
                  example: '2023-07-30T09:00:00.000Z'
                updatedAt:
                  anyOf:
                    - type: string
                    - type: string
                  description: Object update date time
                  example: '2023-07-30T09:00:00.000Z'
              required:
                - firstname
                - lastname
              additionalProperties: false
      responses:
        '200':
          description: Successfully created patient
          content:
            application/json:
              schema:
                type: object
                properties:
                  firstname:
                    type: string
                    description: Patient first name
                    example: Harry
                  lastname:
                    type: string
                    description: Patient last name
                    example: Potter
                  middleName:
                    type: string
                    nullable: true
                    description: Patient middle name
                    example: James
                  preferredName:
                    type: string
                    nullable: true
                    description: Patient preferred name
                    example: Harry
                  title:
                    type: string
                    nullable: true
                    description: Patient title
                    example: Mr.
                  email:
                    type: string
                    nullable: true
                    description: Patient email
                    example: harry@hogwarts.edu
                  sex:
                    type: string
                    nullable: true
                    description: Patient sex
                    example: Male
                  genderIdentity:
                    type: string
                    nullable: true
                    description: Patient gender identity
                    example: Man
                  pronouns:
                    type: string
                    nullable: true
                    description: Patient pronouns
                    example: They/them
                  alert:
                    type: string
                    nullable: true
                    description: Patient alert messages
                    example: He knows magic
                  invoiceRecipientId:
                    type: integer
                    nullable: true
                    minimum: 0
                    exclusiveMinimum: true
                    description: The invoice receipient (contact) id of this patient
                    example: 1
                  birthdate:
                    anyOf:
                      - type: string
                      - type: string
                      - nullable: true
                    description: Patient birthdate in YYYY-MM-DD format
                    example: '1996-07-30T00:00:00.000Z'
                  timezone:
                    type: string
                    nullable: true
                    description: Patient timezone
                    example: Australia/Adelaide
                  extraInfo:
                    type: string
                    nullable: true
                    description: Patient extra info
                    example: Some extra info
                  extraBillingInfo:
                    type: string
                    nullable: true
                    description: Patient extra billing info
                    example: Some extra billing info
                  addressL1:
                    type: string
                    nullable: true
                    description: Patient address line 1
                    example: 123 King William Street
                  addressL2:
                    type: string
                    nullable: true
                    description: Patient address line 2
                    example: ''
                  addressL3:
                    type: string
                    nullable: true
                    description: Patient address line 3
                    example: ''
                  city:
                    type: string
                    nullable: true
                    description: Patient city
                    example: Adelaide
                  state:
                    type: string
                    nullable: true
                    description: Patient state
                    example: SA
                  postalCode:
                    type: string
                    nullable: true
                    description: Patient post code
                    example: '5000'
                  country:
                    type: string
                    nullable: true
                    description: Patient country
                    example: Australia
                  phoneNumbers:
                    type: array
                    nullable: true
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          nullable: true
                          enum:
                            - Mobile
                            - Home
                            - Work
                            - Fax
                            - Other
                          description: Phone number type
                          example: Mobile
                        code:
                          type: string
                          nullable: true
                          description: Phone country code
                          example: '+61'
                        phoneNumber:
                          type: string
                          description: Phone number
                          example: '401234567'
                      required:
                        - phoneNumber
                  privacyPolicy:
                    type: string
                    nullable: true
                    enum:
                      - No response
                      - Accepted
                      - Rejected
                      - ''
                    description: Patient privacy policy status
                    example: Accepted
                  ndisNumber:
                    type: string
                    nullable: true
                    description: Patient NDIS number
                    example: '430123456'
                  ndisInfo:
                    type: object
                    nullable: true
                    properties:
                      diagnosis:
                        type: string
                        nullable: true
                        description: NDIS Diagnosis
                        example: Foot Injury
                      nomineeEmail:
                        type: string
                        nullable: true
                        description: Nominee email
                        example: nominee@email.com
                      fundManagement:
                        type: string
                        nullable: true
                        description: NDIS fund management type
                        example: Plan-managed
                      nomineeLastName:
                        type: string
                        nullable: true
                        description: Last name of nominee
                        example: Clark
                      nomineeFirstName:
                        type: string
                        nullable: true
                        description: First name of nominee
                        example: Chris
                      nomineeMobileCode:
                        type: string
                        nullable: true
                        description: Nominee phone country code
                        example: '+61'
                      nomineeMobileNumber:
                        type: string
                        nullable: true
                        description: Nominee phone number
                        example: '433555111'
                      startDate:
                        type: string
                        nullable: true
                        description: Plan start date
                        example: '2024-02-09T00:00:00.000Z'
                      endDate:
                        type: string
                        nullable: true
                        description: Plan end date
                        example: '2024-02-18T00:00:00.000Z'
                  medicareNum:
                    type: string
                    nullable: true
                    description: Patient Medicare number
                    example: '4444444444'
                  irn:
                    type: string
                    nullable: true
                    description: Patient Medicare reference number
                    example: '1'
                  veteransFileNumber:
                    type: string
                    nullable: true
                    description: Patient veterans information
                    example: ''
                  emergencyContactNumber:
                    type: string
                    nullable: true
                    description: Patient emergency contact number
                    example: '0412345678'
                  emergencyContactName:
                    type: string
                    nullable: true
                    description: Patient emergency contact name
                    example: Quentin Neely
                  emergencyContactRelationship:
                    type: string
                    nullable: true
                    description: Patient emergency contact relationship
                    example: Brother
                  communicationPreference:
                    type: string
                    enum:
                      - NONE
                      - SMS
                      - SMS_EMAIL
                      - EMAIL
                    description: >-
                      Patient communication preference (defaults to
                      organisation's communication preference if not set)
                    example: SMS
                  archived:
                    type: boolean
                    nullable: true
                    default: false
                    description: Whether the patient has been archived
                  id:
                    type: integer
                    minimum: 0
                    exclusiveMinimum: true
                    description: Patient Id
                    example: 1
                  patientTags:
                    type: array
                    nullable: true
                    items:
                      type: string
                    description: Patient tags
                    example:
                      - Self-managed
                  customFields:
                    type: array
                    nullable: true
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                        value:
                          anyOf:
                            - type: string
                            - type: number
                      required:
                        - name
                        - value
                  healthFund:
                    type: object
                    nullable: true
                    properties:
                      name:
                        type: string
                        description: Health fund name
                        example: AHM
                      membershipNumber:
                        type: string
                        nullable: true
                        description: Health fund membership number
                        example: '12345678'
                      patientNumber:
                        type: string
                        nullable: true
                        description: Health fund patient number
                        example: '1'
                      cardIssueNumber:
                        type: string
                        nullable: true
                        description: Health fund card issue number
                        example: '01'
                    required:
                      - name
                  createdAt:
                    anyOf:
                      - type: string
                      - type: string
                    description: Object creation date time
                    example: '2023-07-30T09:00:00.000Z'
                  updatedAt:
                    anyOf:
                      - type: string
                      - type: string
                    description: Object update date time
                    example: '2023-07-30T09:00:00.000Z'
                  deletedAt:
                    anyOf:
                      - type: string
                      - type: string
                      - nullable: true
                    default: null
                    description: Object archived date time
                    example: '2023-07-30T09:00:00.000Z'
                required:
                  - firstname
                  - lastname
                  - id
                  - deletedAt
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````