You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
zoo-api/paths/patient_base.yaml

86 lines
2.9 KiB
YAML

get:
operationId: patientBase
tags:
- Patient
summary: Basic personal patient
description: Get basic personal patient info not directly related to their medical dossier
parameters:
- $ref: '../zoo-api.yaml#/components/parameters/AgbGP'
- name: bsn
in: query
description: |-
The SSN (dutch: _BSN_) of a patient to look up. May only contain digits, cannot contain more than 9 digits, and cannot be 0.
schema:
type: integer
format: int32
minimum: 1
maximum: 999999999
example: 123456789
- name: bsn
in: header
description: |-
An alternate location for the `bsn` parameter.
schema:
type: integer
format: int32
minimum: 1
maximum: 999999999
example: 123456789
- $ref: '../zoo-api.yaml#/components/parameters/Authorization'
responses:
'200':
description: Basic personal information for the patient is returned.
content:
application/json:
schema:
type: object
required:
- bsn
- name
- gender
- patid
- patUnid
- category
- startDate
properties:
bsn:
$ref: '../schemas/PatIdentity.yaml#/bsn'
name:
$ref: '../schemas/PatIdentity.yaml#/name'
gender:
$ref: '../schemas/PatIdentity.yaml#/gender'
dob:
$ref: '../schemas/PatIdentity.yaml#/dob'
category:
$ref: '../schemas/PatIdentity.yaml#/category'
doctor:
$ref: '../schemas/PatIdentity.yaml#/doctor'
address:
$ref: '../schemas/PatIdentity.yaml#/address'
contact:
$ref: '../schemas/PatIdentity.yaml#/contact'
insurance:
$ref: '../schemas/PatIdentity.yaml#/insurance'
patid:
$ref: '../schemas/PatIdentity.yaml#/patid'
patPubId:
$ref: '../schemas/PatIdentity.yaml#/patPubId'
patUnid:
$ref: '../schemas/PatIdentity.yaml#/patUnid'
startDate:
$ref: '../schemas/PatIdentity.yaml#/startDate'
endDate:
$ref: '../schemas/PatIdentity.yaml#/endDate'
endReason:
$ref: '../schemas/PatIdentity.yaml#/endReason'
careprograms:
$ref: '../schemas/PatIdentity.yaml#/careprograms'
'400':
description: The request is invalid; for example, it doesn't contain the required `BSN` parameter.
'401':
$ref: '../zoo-api.yaml#/components/responses/JwtFailure'
'403':
description: Indicated practice is known but has not authorized ZOO to share this information with signer.
'404':
$ref: '../zoo-api.yaml#/components/responses/PatNotFound'