/fhir/hpi/v1/metadata:
    get:
      summary: "Returns the server's capability statement"
      operationId: "hpiMetadata"
      parameters:
      - name: "userid"
        in: "header"
        required: true
        schema:
          type: "string"
      - name: "X-correlation-ID"
        in: "header"
        schema:
          type: "string"
      - name: "x-api-key"
        in: "header"
        required: false
        schema:
          type: "string"
      - name: "X-Request-Id"
        in: "header"
        schema:
          type: "string"
      - name: "mode"
        in: "query"
        schema:
          type: "string"
      responses:
        "200":
          description: "200 response"
          content: {}
        "400":
          description: "400 response"
          content: {}
        "422":
          description: "422 response"
          content: {}
        "401":
          description: "401 response"
          headers:
            WWW-Authenticate:
              schema:
                type: "string"
          content: {}
      security:
     
      - api_key: []
      
      x-amazon-apigateway-request-validator: "params-only"
      x-amazon-apigateway-integration:
                type: "aws_proxy"
                httpMethod: "POST"
                uri:
                  Ref: pLambdaNameHpi
                passthroughBehavior: "when_no_match"
                timeoutInMillis: 29000
/fhir/hpi/v1/Location:
    get:
      summary: "Search for a Location"
      operationId: "locationGet"
      parameters:
      - name: "dhb"
        in: "query"
        schema:
          type: "string"
      - name: "userid"
        in: "header"
        required: true
        schema:
          type: "string"
      - name: "organization"
        in: "query"
        schema:
          type: "string"
      - name: "x-api-key"
        in: "header"
        required: true
        schema:
          type: "string"
      - name: "name"
        in: "query"
        schema:
          type: "string"
      - name: "type"
        in: "query"
        schema:
          type: "string"
      - name: "X-Request-Id"
        in: "header"
        schema:
          type: "string"
      - name: "identifier"
        in: "query"
        schema:
          type: "string"
      - name: "address"
        in: "query"
        schema:
          type: "string"
      - name: "X-correlation-ID"
        in: "header"
        schema:
          type: "string"
      - name: "_count"
        in: "query"
        schema:
          type: "string"
      responses:
        "200":
          description: "200 response"
          content: {}
        "400":
          description: "400 response"
          content: {}
        "422":
          description: "422 response"
          content: {}
        "401":
          description: "401 response"
          headers:
            WWW-Authenticate:
              schema:
                type: "string"
          content: {}
      security:
      - hip-fhir-cog:
       
        - "https://api.hip.digital.health.nz/fhir/system/Location.s"
        - "https://api.hip.digital.health.nz/fhir/system/Location.r"
        - "https://api.hip.digital.health.nz/fhir/system/Location.a"
      - api_key: []
      
      x-amazon-apigateway-request-validator: "params-only"
      x-amazon-apigateway-integration:
                type: "aws_proxy"
                httpMethod: "POST"
                uri:
                  Ref: pLambdaNameHpi
                passthroughBehavior: "when_no_match"
                timeoutInMillis: 29000

    
/fhir/hpi/v1/Location/{location-id}:
    get:
      summary: "retrieve a Location by id"
      operationId: "locationGetById"
      parameters:
      - name: "userid"
        in: "header"
        required: true
        schema:
          type: "string"
      - name: "location-id"
        in: "path"
        required: true
        schema:
          type: "string"
      - name: "X-correlation-ID"
        in: "header"
        schema:
          type: "string"
      - name: "x-api-key"
        in: "header"
        required: true
        schema:
          type: "string"
      - name: "X-Request-Id"
        in: "header"
        schema:
          type: "string"
      responses:
        "400":
          description: "400 response"
          content: {}
        "200":
          description: "200 response"
          content: {}
      security:
      - hip-fhir-cog:        
        - "https://api.hip.digital.health.nz/fhir/system/Location.r"
        - "https://api.hip.digital.health.nz/fhir/system/Location.a"
      - api_key: []
      
      x-amazon-apigateway-request-validator: "params-only"
      x-amazon-apigateway-integration:
                type: "aws_proxy"
                httpMethod: "POST"
                uri:
                  Ref: pLambdaNameHpi
                passthroughBehavior: "when_no_match"
                timeoutInMillis: 29000
               
/fhir/hpi/v1/Organization:
    get:
      summary: "Search for an Organization"
      operationId: "organizationGet"
      parameters:
      - name: "userid"
        in: "header"
        required: true
        schema:
          type: "string"
      - name: "x-api-key"
        in: "header"
        required: true
        schema:
          type: "string"
      - name: "name"
        in: "query"
        schema:
          type: "string"
      - name: "type"
        in: "query"
        schema:
          type: "string"
      - name: "X-Request-Id"
        in: "header"
        schema:
          type: "string"
      - name: "identifier"
        in: "query"
        schema:
          type: "string"
      - name: "_revinclude"
        in: "query"
        schema:
          type: "string"
      - name: "X-correlation-ID"
        in: "header"
        schema:
          type: "string"
      - name: "partof"
        in: "query"
        schema:
          type: "string"
      - name: "_count"
        in: "query"
        schema:
          type: "string"
      - name: "_include"
        in: "query"
        schema:
          type: "string"
      responses:
        "200":
          description: "200 response"
          content: {}
        "400":
          description: "400 response"
          content: {}
        "422":
          description: "422 response"
          content: {}
        "401":
          description: "401 response"
          headers:
            WWW-Authenticate:
              schema:
                type: "string"
          content: {}
      security:
      - hip-fhir-cog:      
        - "https://api.hip.digital.health.nz/fhir/system/Organization.r"
        - "https://api.hip.digital.health.nz/fhir/system/Organization.s"
        - "https://api.hip.digital.health.nz/fhir/system/Organization.a"
      - api_key: []
      x-amazon-apigateway-request-validator: "params-only"
      x-amazon-apigateway-integration:
                type: "aws_proxy"
                httpMethod: "POST"
                uri:
                  Ref: pLambdaNameHpi
                passthroughBehavior: "when_no_match"
                timeoutInMillis: 29000

/fhir/hpi/v1/Organization/{organization-id}:
    get:
      summary: "retrieve an Organization id"
      operationId: "organizationById"
      parameters:
      - name: "userid"
        in: "header"
        required: true
        schema:
          type: "string"
      - name: "X-correlation-ID"
        in: "header"
        schema:
          type: "string"
      - name: "organization-id"
        in: "path"
        required: true
        schema:
          type: "string"
      - name: "x-api-key"
        in: "header"
        required: true
        schema:
          type: "string"
      - name: "X-Request-Id"
        in: "header"
        schema:
          type: "string"
      responses:
        "400":
          description: "400 response"
          content: {}
        "422":
          description: "422 response"
          content: {}
        "200":
          description: "200 response"
          content: {}
      security:
      - hip-fhir-cog:    
        - "https://api.hip.digital.health.nz/fhir/system/Organization.r"
        - "https://api.hip.digital.health.nz/fhir/system/Organization.a"
      - api_key: []
      
      x-amazon-apigateway-request-validator: "params-only"
      x-amazon-apigateway-integration:
                type: "aws_proxy"
                httpMethod: "POST"
                uri:
                  Ref: pLambdaNameHpi
                passthroughBehavior: "when_no_match"
                timeoutInMillis: 29000
                
/fhir/hpi/v1/Practitioner:
    get:  
      summary: "search for a Practitioner"
      operationId: "practitionerGet"
      parameters:
      - name: "userid"
        in: "header"
        required: true
        schema:
          type: "string"
      - name: "gender"
        in: "query"
        schema:
          type: "string"
      - name: "x-api-key"
        in: "header"
        required: true
        schema:
          type: "string"
      - name: "name"
        in: "query"
        schema:
          type: "string"
      - name: "X-Request-Id"
        in: "header"
        schema:
          type: "string"
      - name: "identifier"
        in: "query"
        schema:
          type: "string"
      - name: "birthdate"
        in: "query"
        schema:
          type: "string"
      - name: "_revinclude"
        in: "query"
        schema:
          type: "string"
      - name: "X-correlation-ID"
        in: "header"
        schema:
          type: "string"
      - name: "_count"
        in: "query"
        schema:
          type: "string"
      - name: "_include"
        in: "query"
        schema:
          type: "string"
      responses:
        "200":
          description: "200 response"
          content: {}
        "400":
          description: "400 response"
          content: {}
        "422":
          description: "422 response"
          content: {}
        "401":
          description: "401 response"
          headers:
            WWW-Authenticate:
              schema:
                type: "string"
          content: {}
      security:
      - hip-fhir-cog:        
        - "https://api.hip.digital.health.nz/fhir/system/Practitioner.r"
        - "https://api.hip.digital.health.nz/fhir/system/Practitioner.s"
        - "https://api.hip.digital.health.nz/fhir/system/Practitioner.a"
      - api_key: []
      
      x-amazon-apigateway-request-validator: "params-only"
      x-amazon-apigateway-integration:
                # type of Lambda Integration - NOTE: when using aws_proxy the responses below are not in use - responses are passed from lambda through
                type: "aws_proxy"
                httpMethod: "POST"
                uri:
                  Ref: pLambdaNameHpi
                passthroughBehavior: "when_no_match"
                # standard 29 second timeout value
                timeoutInMillis: 29000
    post:
      summary: "create a new Practitioner"
      operationId: "practitionerPost"
      parameters:
      - name: "userid"
        in: "header"
        required: true
        schema:
          type: "string"
      - name: "X-correlation-ID"
        in: "header"
        schema:
          type: "string"
      - name: "x-api-key"
        in: "header"
        required: true
        schema:
          type: "string"
      - name: "X-Request-Id"
        in: "header"
        schema:
          type: "string"
      responses:
        "422":
          description: "422 response"
          content: {}
        "204":
          description: "204 response"
          headers:
            Content-Location:
              schema:
                type: "string"
          content: {}
      security:
      - hip-fhir-cog:       
        - "https://api.hip.digital.health.nz/fhir/system/Practitioner.c"
        - "https://api.hip.digital.health.nz/fhir/system/Practitioner.a"
      - api_key: []
      x-amazon-apigateway-integration:
                type: "aws_proxy"
                httpMethod: "POST"
                uri:
                  Ref: pLambdaNameHpi
                passthroughBehavior: "when_no_match"
                timeoutInMillis: 29000
                
/fhir/hpi/v1/Practitioner/{practitioner-id}:
    get:  
      summary: "retrieve a Practitioner by id"
      operationId: "practitionerGetById"
      parameters:
      - name: "userid"
        in: "header"
        required: true
        schema:
          type: "string"
      - name: "X-correlation-ID"
        in: "header"
        schema:
          type: "string"
      - name: "practitioner-id"
        in: "path"
        required: true
        schema:
          type: "string"
      - name: "x-api-key"
        in: "header"
        required: true
        schema:
          type: "string"
      - name: "X-Request-Id"
        in: "header"
        schema:
          type: "string"
      responses:
        "400":
          description: "400 response"
          content: {}
        "422":
          description: "422 response"
          content: {}
        "200":
          description: "200 response"
          content: {}
      security:
      - hip-fhir-cog:     
        - "https://api.hip.digital.health.nz/fhir/system/Practitioner.r"
        - "https://api.hip.digital.health.nz/fhir/system/Practitioner.a"
      - api_key: []
      
      x-amazon-apigateway-request-validator: "params-only"
      x-amazon-apigateway-integration:
                type: "aws_proxy"
                httpMethod: "POST"
                uri:
                  Ref: pLambdaNameHpi
                passthroughBehavior: "when_no_match"
   
/fhir/hpi/v1/PractitionerRole:
    get:
      summary: "search for a PractitionerRole"
      operationId: "practitionerRoleGet"
      parameters:
      - name: "userid"
        in: "header"
        required: true
        schema:
          type: "string"
      - name: "organization"
        in: "query"
        schema:
          type: "string"
      - name: "x-api-key"
        in: "header"
        required: true
        schema:
          type: "string"
      - name: "X-Request-Id"
        in: "header"
        schema:
          type: "string"
      - name: "identifier"
        in: "query"
        schema:
          type: "string"
      - name: "_revinclude"
        in: "query"
        schema:
          type: "string"
      - name: "X-correlation-ID"
        in: "header"
        schema:
          type: "string"
      - name: "practitioner"
        in: "query"
        schema:
          type: "string"
      - name: "location"
        in: "query"
        schema:
          type: "string"
      - name: "active"
        in: "query"
        schema:
          type: "string"
      - name: "_count"
        in: "query"
        schema:
          type: "string"
      - name: "_include"
        in: "query"
        schema:
          type: "string"
      responses:
        "200":
          description: "200 response"
          content: {}
        "400":
          description: "400 response"
          content: {}
        "422":
          description: "422 response"
          content: {}
        "401":
          description: "401 response"
          headers:
            WWW-Authenticate:
              schema:
                type: "string"
          content: {}
      security:
      - hip-fhir-cog:
       
        - "https://api.hip.digital.health.nz/fhir/system/PractitionerRole.r"
        - "https://api.hip.digital.health.nz/fhir/system/PractitionerRole.s"
        - "https://api.hip.digital.health.nz/fhir/system/PractitionerRole.a"
      - api_key: []
      
      x-amazon-apigateway-request-validator: "params-only"
      x-amazon-apigateway-integration:
                type: "aws_proxy"
                httpMethod: "POST"
                uri:
                  Ref: pLambdaNameHpi
                passthroughBehavior: "when_no_match"
                timeoutInMillis: 29000
    post:
      summary: "create a new PractitionerRole "
      operationId: "practitionerRolePost"
      parameters:
      - name: "userid"
        in: "header"
        required: true
        schema:
          type: "string"
      - name: "X-correlation-ID"
        in: "header"
        schema:
          type: "string"
      - name: "x-api-key"
        in: "header"
        required: true
        schema:
          type: "string"
      - name: "X-Request-Id"
        in: "header"
        schema:
          type: "string"
      responses:
        "422":
          description: "422 response"
          content: {}
        "204":
          description: "204 response"
          headers:
            Content-Location:
              schema:
                type: "string"
          content: {}
      security:
      - hip-fhir-cog:
        
        - "https://api.hip.digital.health.nz/fhir/system/PractitionerRole.c"
        - "https://api.hip.digital.health.nz/fhir/system/PractitionerRole.a"
      - api_key: []
      
      x-amazon-apigateway-request-validator: params-and-body
      x-amazon-apigateway-integration:
                type: "aws_proxy"
                httpMethod: "POST"
                uri:
                  Ref: pLambdaNameHpi
                passthroughBehavior: "when_no_match"
                timeoutInMillis: 29000
      


/fhir/hpi/v1/PractitionerRole/{practitioner-role-id}:
    get:
      summary: "get a PractitionerRole by id"
      operationId: "practitionerRoleGetById"
      parameters:
      - name: "userid"
        in: "header"
        required: true
        schema:
          type: "string"
      - name: "X-correlation-ID"
        in: "header"
        schema:
          type: "string"
      - name: "practitioner-role-id"
        in: "path"
        required: true
        schema:
          type: "string"
      - name: "x-api-key"
        in: "header"
        required: true
        schema:
          type: "string"
      - name: "X-Request-Id"
        in: "header"
        schema:
          type: "string"
      responses:
        "400":
          description: "400 response"
          content: {}
        "200":
          description: "200 response"
          content: {}
      security:
      - hip-fhir-cog:
       
        - "https://api.hip.digital.health.nz/fhir/system/PractitionerRole.r"
        - "https://api.hip.digital.health.nz/fhir/system/PractitionerRole.a"
      - api_key: []
      
      x-amazon-apigateway-request-validator: "params-only"
      x-amazon-apigateway-integration:
                type: "aws_proxy"
                httpMethod: "POST"
                uri:
                  Ref: pLambdaNameHpi
                passthroughBehavior: "when_no_match"
                timeoutInMillis: 29000
    put:
      summary: " update a PractitionerRole"
      operationId: "practitionerRolePut"
      parameters:
      - name: "userid"
        in: "header"
        required: true
        schema:
          type: "string"
      - name: "X-correlation-ID"
        in: "header"
        schema:
          type: "string"
      - name: "practitioner-role-id"
        in: "path"
        required: true
        schema:
          type: "string"
      - name: "x-api-key"
        in: "header"
        required: true
        schema:
          type: "string"
      - name: "X-Request-Id"
        in: "header"
        schema:
          type: "string"
      responses:
        "422":
          description: "422 response"
          content: {}
        "200":
          description: "200 response"
          content: {}
      security:
      - hip-fhir-cog:
        
        - "https://api.hip.digital.health.nz/fhir/system/PractitionerRole.u"
        - "https://api.hip.digital.health.nz/fhir/system/PractitionerRole.a"
      - api_key: []
      x-amazon-apigateway-integration:
                type: "aws_proxy"
                httpMethod: "POST"
                uri:
                  Ref: pLambdaNameHpi
                passthroughBehavior: "when_no_match"
                timeoutInMillis: 29000