Reintroduced contact list:
See commit cef3aff.
parent
84d010a78c
commit
c5ad817b49
@ -0,0 +1,68 @@
|
||||
get:
|
||||
operationId: contactList
|
||||
tags:
|
||||
- Patient
|
||||
summary: Contact list
|
||||
description: Get a contact list for printing address labels, sending e-mail and/ or calling.
|
||||
parameters:
|
||||
- name: patUnids
|
||||
in: query
|
||||
description: |-
|
||||
A comma separated list of patUnid's. For each patUnid the contact details are in the response. On a query string there is no standardized limit, but in practice the list of unid's might be limited to approximate 512 id's.
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../schemas/pat-patUnid.yaml
|
||||
maxItems: 512
|
||||
example: "1234,5678"
|
||||
- name: Accept
|
||||
in: header
|
||||
description: |-
|
||||
CSV (RFC 4180) or JSON is responded depending on the preference set by the callers HTTP Accept header. The Accept header is processed according RFC 9110. If one of media-types below has the most weight, then that type will be the content-type of the response. This is always the case when the header equals one of the enumerated types.
|
||||
schema:
|
||||
type: string
|
||||
enum:
|
||||
- text/csv
|
||||
- application/json
|
||||
responses:
|
||||
'200':
|
||||
description: A patient contact list for (electronic) mailing or phone contact. The list can be responded as CSV or JSON.
|
||||
headers:
|
||||
Content-Type:
|
||||
description: The actual content-type of the response.
|
||||
schema:
|
||||
type: string
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
patPubId:
|
||||
$ref: '../schemas/PatIdentity.yaml#/patPubId'
|
||||
patUnid:
|
||||
$ref: '../schemas/PatIdentity.yaml#/patUnid'
|
||||
displayName:
|
||||
$ref: '../schemas/pat-Name.yaml#/properties/displayName'
|
||||
addressLine:
|
||||
description: The concatenation of street, housenumber and -suffix on one line.
|
||||
type: string
|
||||
postcode:
|
||||
$ref: ../schemas/postcode.yaml
|
||||
city:
|
||||
$ref: ../schemas/city.yaml
|
||||
tel:
|
||||
$ref: '../schemas/PatIdentity.yaml#/contact/properties/tel'
|
||||
email:
|
||||
$ref: '../schemas/PatIdentity.yaml#/contact/properties/email'
|
||||
text/csv:
|
||||
schema:
|
||||
type: string
|
||||
'400':
|
||||
description: The request is invalid; for example, it doesn't contain the required `patUnids` parameter.
|
||||
'401':
|
||||
$ref: '../zoo-api.yaml#/components/responses/JwtFailure'
|
||||
'404':
|
||||
$ref: '../zoo-api.yaml#/components/responses/PatNotFound'
|
||||
|
||||
Loading…
Reference in New Issue