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/schemas/med_dossier/Correspondence.yaml

58 lines
2.1 KiB
YAML

type: object
required:
- direction
- when
- text
properties:
direction:
description: |-
The direction of the correspondence.
* `S` means it was sent/initiated from the GP office to `other`.
* `R` means it was sent/initiated from `other` to the GP office.
* `X` means the direction isn't known.
type: string
example: S
enum:
- S
- R
- X
when:
description: |-
The date when this correspondence was received or sent.
type: string
format: date
example: "2023-03-31"
speciality_code:
description: |-
A short memocode representing the speciality of `other`. For example, `"OOG"` (eye specialist), `"CHI"` (Surgery), etc. Often blank.
OPEN QUESTION: Is an explicitly enumerated list of all possible values warranted? We'd love to receive sources of such lists.
type: string
example: KNO
episode:
description: |-
*OPTIONAL* An ICPC code (formatted as e.g. `X99.12`) representing the problem or chronic illness that serves as context for this correspondence.
Not all correspondence can be directly related to an ICPC code, and many source systems fundamentally do not allow linking correspondence to
a given medical issue. Hence, this field is usually blank.
type: string
pattern: '^[A-Z]\d{2}\.\d{2}$'
text:
description: |-
The content of the correspondence, as registered in the source system. This usually describes the nature of the content, or is merely a fragment
of the content, or is simply blank - most source systems do not store a copy of the entire conversation in text form.
type: string
example: Echo
other:
description: |-
A free-form textual description of the other party in this correspondence.
type: string
example: "Naar: Plastische chirurgie HMC, Den Haag"
practitioner:
$ref: 'Practitioner.yaml'
zorgdomein:
description: |-
If known and provided, The ZorgDomein message ID. ZorgDomein IDs are often used when referring a patient. Not all source systems provide these.
type: string
example: "ZD1234"