swagger: '2.0'
info:
  description: Welcome to the Home and Community Support Services (HCSS) APIs. HCSS is a contract issued to only a few external parties so ti pays to check with your user base first.
  version: 0.0.109-SNAPSHOT
  title: Home and Community Support Services 2019
  termsOfService: 'https://developer.acc.co.nz/terms-conditions'
  license:
    name: Apache 2.0
    url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
host: api-compliance.acc.co.nz
basePath: /v1/provider/home-community-support-services
tags:
  - name: HCSS 2019
    description: Home and Community Support Services 2019
schemes:
  - https
securityDefinitions:
  apiKeyHeader:
    type: apiKey
    name: apikey
    in: header
security:
  - apiKeyHeader: []  
paths:
  /service/completion:
    post:
      tags:
        - HCSS 2019
      summary: Submit a service completion report
      description: HCSS is a contract issued to only a few external parties. There is a series of APIs to consider.This specific API supports the submission of a service completion report
      operationId: Service Completion
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/ServiceCompletion'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/HCSSResponse'
            
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /service/consultations:
    post:
      tags:
        - HCSS 2019
      summary: Submit a service consultation report
      description: HCSS is a contract issued to only a few external parties. There is a series of APIs to consider.This specific API supports the submission of a service consultation report
      operationId: Service Consultations
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/ServiceConsultation'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/HCSSResponse'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /service/review:
    post:
      tags:
        - HCSS 2019
      summary: Submit a service review report
      description: HCSS is a contract issued to only a few external parties. There is a series of APIs to consider.This specific API supports the submission of a service review report
      operationId: Service Review
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/ServiceReview'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/HCSSResponse'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /service/start:
    post:
      tags:
        - HCSS 2019
      summary: Submit a service commencement report
      description: HCSS is a contract issued to only a few external parties. There is a series of APIs to consider.This specific API supports the submission of a service commencement report
      operationId: Service Commencement
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/ServiceCommencement'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/HCSSResponse'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /supplier:
    post:
      tags:
        - HCSS 2019
      summary: Submit a supplier review report
      description: HCSS is a contract issued to only a few external parties. There is a series of APIs to consider.This specific API supports the submission of a supplier review report
      operationId: Supplier Review
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/SupplierReview'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/HCSSResponse'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
definitions:
  DHBStats:
    type: object
    required:
      - familyOrNominatedCarers
      - level2StaffEmployed
      - level3StaffEmployed
      - level4StaffEmployed
      - nursesEmployed
      - occTherapistsEmployed
      - physiotherapistsEmployed
      - referralsDeclined
      - serviceHoursDelivered
      - serviceHoursNotDelivered
      - totalStaffEmployed
      - totalStaffInTraining
    properties:
      familyOrNominatedCarers:
        type: integer
        format: int32
      level2StaffEmployed:
        type: integer
        format: int32
      level3StaffEmployed:
        type: integer
        format: int32
      level4StaffEmployed:
        type: integer
        format: int32
      nursesEmployed:
        type: integer
        format: int32
      occTherapistsEmployed:
        type: integer
        format: int32
      physiotherapistsEmployed:
        type: integer
        format: int32
      referralsDeclined:
        type: integer
        format: int32
      serviceHoursDelivered:
        type: integer
        format: int32
      serviceHoursNotDelivered:
        type: integer
        format: int32
      totalStaffEmployed:
        type: integer
        format: int32
      totalStaffInTraining:
        type: integer
        format: int32
  ServiceCompletion:
    type: object
    required:
      - alliedHealthIncluded
      - claimNumber
      - firstEpisodeOfCareDate
      - nursingIncluded
      - occTherapyConsultations
      - physioConsultations
      - serviceType
      - supplierId
    properties:
      alliedHealthCompletionDate:
        type: string
        format: date
      alliedHealthIncluded:
        type: string
        enum:
          - 'Yes'
          - 'No'
      alliedHealthStartDate:
        type: string
        format: date
      claimNumber:
        type: string
        description: 'That is, any one of:  A123456, AA12345, 1234567, 12345678901, A1234567890 where A represents an alphabetic character and each digit represents any digit.'
      completionDate:
        type: string
        format: date
      extendedServiceExitOtherReason:
        type: string
      extendedServiceExitReason:
        type: string
        enum:
          - Support no longer needed
          - Transferred to another supplier
          - Transferred to another service funded by ACC
          - Transferred to another service not funded by ACC
          - Client deceased
          - Other outcome
      firstEpisodeOfCareDate:
        type: string
        format: date
        description: "For SIP, the first episode of care should be within 24 hours of the client's discharge;  otherwise within 24 hours of the start date the client requested, or the date given on the referral."
      nursingAssessmentDate:
        type: string
        format: date
      nursingCompletionDate:
        type: string
        format: date
      nursingConsultations:
        type: integer
        format: int32
      nursingIncluded:
        type: string
        enum:
          - 'Yes'
          - 'No'
      occTherapyConsultations:
        type: integer
        format: int32
      physioConsultations:
        type: integer
        format: int32
      serviceType:
        type: string
        enum:
          - Standard
          - Extended
          - SIP
      sipReferralSource:
        type: string
        enum:
          - Northland
          - Waitemata
          - Auckland
          - Counties Manukau
          - Waikato
          - Bay of Plenty
          - Taranaki
          - Lakes
          - Tairawhiti
          - Whanganui
          - MidCentral
          - "Hawke's Bay"
          - 'Capital & Coast'
          - Hutt Valley
          - Wairarapa
          - Nelson Marlborough
          - West Coast
          - Canterbury
          - South Canterbury
          - Southern
      standardServiceOtherOutcome:
        type: string
      standardServiceOutcome:
        type: string
        enum:
          - Full independence achieved
          - Partial independence achieved
          - Transferred to another supplier
          - Transferred to another service funded by ACC
          - Transferred to another service not funded by ACC
          - Client deceased
          - Other outcome
      supplierId:
        type: string
        enum:
          - G04338
          - G00059
          - G04327
          - G04317
          - S95581
  SupplierReview:
    type: object
    required:
      - Auckland
      - Bay of Plenty
      - Canterbury
      - 'Capital & Coast'
      - Counties Manukau
      - "Hawke's Bay"
      - Hutt Valley
      - Lakes
      - MidCentral
      - Nelson Marlborough
      - Northland
      - South Canterbury
      - Southern
      - Tairawhiti
      - Taranaki
      - Waikato
      - Wairarapa
      - Waitemata
      - West Coast
      - Whanganui
      - supplierId
    properties:
      Auckland:
        $ref: '#/definitions/DHBStats'
      Bay of Plenty:
        $ref: '#/definitions/DHBStats'
      Canterbury:
        $ref: '#/definitions/DHBStats'
      'Capital & Coast':
        $ref: '#/definitions/DHBStats'
      Counties Manukau:
        $ref: '#/definitions/DHBStats'
      "Hawke's Bay":
        $ref: '#/definitions/DHBStats'
      Hutt Valley:
        $ref: '#/definitions/DHBStats'
      Lakes:
        $ref: '#/definitions/DHBStats'
      MidCentral:
        $ref: '#/definitions/DHBStats'
      Nelson Marlborough:
        $ref: '#/definitions/DHBStats'
      Northland:
        $ref: '#/definitions/DHBStats'
      South Canterbury:
        $ref: '#/definitions/DHBStats'
      Southern:
        $ref: '#/definitions/DHBStats'
      Tairawhiti:
        $ref: '#/definitions/DHBStats'
      Taranaki:
        $ref: '#/definitions/DHBStats'
      Waikato:
        $ref: '#/definitions/DHBStats'
      Wairarapa:
        $ref: '#/definitions/DHBStats'
      Waitemata:
        $ref: '#/definitions/DHBStats'
      West Coast:
        $ref: '#/definitions/DHBStats'
      Whanganui:
        $ref: '#/definitions/DHBStats'
      supplierId:
        type: string
        enum:
          - G04338
          - G00059
          - G04327
          - G04317
          - S95581
  ServiceCommencement:
    type: object
    required:
      - claimNumber
      - firstContactDate
      - firstEpisodeOfCareDate
      - referralDate
      - requestedStartDate
      - servicePlanSubmittedDate
      - serviceType
      - supplierId
    properties:
      claimNumber:
        type: string
        description: 'That is, any one of:  A123456, AA12345, 1234567, 12345678901, A1234567890 where A represents an alphabetic character and each digit represents any digit.'
      firstContactDate:
        type: string
        format: date
        description: "For SIP, this should be within 4 hours of the client's discharge. If this is in person, it is the first episode of care."
      firstEpisodeOfCareDate:
        type: string
        format: date
        description: "For SIP, the first episode of care should be within 24 hours of the client's discharge;  otherwise within 24 hours of the start date the client requested, or the date given on the referral."
      referralDate:
        type: string
        format: date
      requestedStartDate:
        type: string
        format: date
        description: 'Either the date the client asked for service to start, or the date given on the referral.'
      servicePlanSubmittedDate:
        type: string
        format: date
      serviceType:
        type: string
        enum:
          - Standard
          - Extended
          - SIP
      sipReferralSource:
        type: string
        enum:
          - Northland
          - Waitemata
          - Auckland
          - Counties Manukau
          - Waikato
          - Bay of Plenty
          - Taranaki
          - Lakes
          - Tairawhiti
          - Whanganui
          - MidCentral
          - "Hawke's Bay"
          - 'Capital & Coast'
          - Hutt Valley
          - Wairarapa
          - Nelson Marlborough
          - West Coast
          - Canterbury
          - South Canterbury
          - Southern
      supplierId:
        type: string
        enum:
          - G04338
          - G00059
          - G04327
          - G04317
          - S95581
  HCSSResponse:
    type: object
    properties:
      createdAt:
        type: string
        format: date
      status:
        type: string
      submittedForm:
        type: object
  ServiceReview:
    type: object
    required:
      - claimNumber
      - firstEpisodeOfCareDate
      - reviewDate
      - reviewType
      - serviceType
      - supplierId
      - transitionFrom
    properties:
      claimNumber:
        type: string
        description: 'That is, any one of:  A123456, AA12345, 1234567, 12345678901, A1234567890 where A represents an alphabetic character and each digit represents any digit.'
      firstEpisodeOfCareDate:
        type: string
        format: date
      reviewDate:
        type: string
        format: date
      reviewType:
        type: string
        enum:
          - First review
          - Subsequent review
      serviceType:
        type: string
        enum:
          - Standard
          - Extended
          - SIP
      supplierId:
        type: string
        enum:
          - G04338
          - G00059
          - G04327
          - G04317
          - S95581
      transitionFrom:
        type: string
        enum:
          - No transition
          - SIP to standard
          - SIP to extended
          - Standard to extended
  ServiceConsultation:
    type: object
    required:
      - claimNumber
      - occTherapyConsultations
      - physioConsultations
      - serviceType
      - supplierId
    properties:
      claimNumber:
        type: string
        description: 'That is, any one of:  A123456, AA12345, 1234567, 12345678901, A1234567890 where A represents an alphabetic character and each digit represents any digit.'
      nursingConsultations:
        type: integer
        format: int32
      occTherapyConsultations:
        type: integer
        format: int32
      physioConsultations:
        type: integer
        format: int32
      serviceType:
        type: string
        enum:
          - Standard
          - Extended
          - SIP
      supplierId:
        type: string
        enum:
          - G04338
          - G00059
          - G04327
          - G04317
          - S95581
  Date:
    type: object
    properties:
      date:
        type: integer
        format: int32
      day:
        type: integer
        format: int32
      hours:
        type: integer
        format: int32
      minutes:
        type: integer
        format: int32
      month:
        type: integer
        format: int32
      seconds:
        type: integer
        format: int32
      time:
        type: integer
        format: int64
      timezoneOffset:
        type: integer
        format: int32
      year:
        type: integer
        format: int32
