Transaction: Incapacity Notification
General information
STATUS:
Published
OWNER:
eHealth Platform
STANDARD:
KMEHR
VERSION:
1.0
DATE:
2013-07-10
DEFINITION:
This transaction notifies of an incapacity of the patient. It is a specialisation of the 'notification' transaction.
IMPORTANT: Please note the incapacity notification transaction for Medex must follow specific rules that are not all outlined on this page. The specific documentation for Medex is available on the Medex site.
STATUS:
Published
OWNER:
eHealth Platform
STANDARD:
KMEHR
VERSION:
1.0
DATE:
2013-07-10
DEFINITION:
This transaction notifies of an incapacity of the patient. It is a specialisation of the 'notification' transaction.
IMPORTANT: Please note the incapacity notification transaction for Medex must follow specific rules that are not all outlined on this page. The specific documentation for Medex is available on the Medex site.
Guidelines
Generalities
This transaction requires a level 3-4 of kmehr normalization: contents are preferably coded however some textual contents are still allowed.
Transaction elements
Element | Purpose |
---|---|
id |
id of the transaction according to the ID-KMEHR conventions. |
Cd |
You must use the value ‘notification’ from CD-TRANSACTION. This must be combined with an appropriate value from CD-TRANSACTION-TYPE. |
Date |
This is the date on which the incapacity is determined |
Time |
This is the time at which the incapacity is determined |
Author |
This is the person assuming the responsibility of the medical content of the record. It can be specified by a combination of hcparty. There must be at least one hcparty identifying a person. It must contain the ID-HCPARTY of this healthcare professional and it should contain its INSS number. |
Recipient |
In case of a Medex message: the recipient will be the application ‘medex’ |
Iscomplete |
Expresses if the incapacity notification is completed. |
Isvalidated |
Expresses if the incapacity notification is validated. |
Structure overview
An Incapacity Notification transaction is composed of multiple items (from CD-ITEM). When it concerns a work accident (determined by the value in CD-INCAPACITY), a supplementary content tag will be present in the incapacity item to define the date of the accident.
Items
The following items from CD-ITEM must be used to compose a incapacity notification transaction, according to the proposed cardinalities. Optional elements in item structure are set within squared braces.
Item type (cd) |
|
Item purpose |
Item structure |
---|---|---|---|
incapacity |
1-* |
Specifies an incapacity of the patient |
content (incapacity)(cd) identifies the type of incapacity, with values from CD-INCAPACITY. |
content (incapacity)(incapacityreason) identifies the reason of incapacity, with values from CD-INCAPACITYREASON. |
|||
content (incapacity)(outofhomeallowed) Indicates if the patient is allowed to leave his home during the incapacity. Possible values : true/false |
|||
[content (date)] In case of a work accident (incapacityreason = workaccident), the date of the work accident. In the case of an Occupational disease (incapacityreason = occupationaldisease), the request date for a dossier for occupational disease. Format : date |
|||
[content (text)] Extra indications for this specific incapacity, in free text Format : text |
|||
[beginmoment] Specifies when the incapacity starts. Format : date |
|||
[endmoment] Specifies when the current period of incapacity ends. Format : date |
|||
diagnosis |
1 |
Describes the diagnosis that is the reason for this incapacity. This information is ONLY allowed in the incapacity transaction for Medex! |
[content (cd)] A coded form of the diagnosis. |
[content (text)] A text with the description of the diagnosis. |
Generalities
This transaction requires a level 3-4 of kmehr normalization: contents are preferably coded however some textual contents are still allowed.
Transaction elements
Element | Purpose |
---|---|
id |
id of the transaction according to the ID-KMEHR conventions. |
Cd |
You must use the value ‘notification’ from CD-TRANSACTION. This must be combined with an appropriate value from CD-TRANSACTION-TYPE. |
Date |
This is the date on which the incapacity is determined |
Time |
This is the time at which the incapacity is determined |
Author |
This is the person assuming the responsibility of the medical content of the record. It can be specified by a combination of hcparty. There must be at least one hcparty identifying a person. It must contain the ID-HCPARTY of this healthcare professional and it should contain its INSS number. |
Recipient |
In case of a Medex message: the recipient will be the application ‘medex’ |
Iscomplete |
Expresses if the incapacity notification is completed. |
Isvalidated |
Expresses if the incapacity notification is validated. |
Structure overview
An Incapacity Notification transaction is composed of multiple items (from CD-ITEM). When it concerns a work accident (determined by the value in CD-INCAPACITY), a supplementary content tag will be present in the incapacity item to define the date of the accident.
Items
The following items from CD-ITEM must be used to compose a incapacity notification transaction, according to the proposed cardinalities. Optional elements in item structure are set within squared braces.
Item type (cd) |
|
Item purpose |
Item structure |
---|---|---|---|
incapacity |
1-* |
Specifies an incapacity of the patient |
content (incapacity)(cd) identifies the type of incapacity, with values from CD-INCAPACITY. |
content (incapacity)(incapacityreason) identifies the reason of incapacity, with values from CD-INCAPACITYREASON. |
|||
content (incapacity)(outofhomeallowed) Indicates if the patient is allowed to leave his home during the incapacity. Possible values : true/false |
|||
[content (date)] In case of a work accident (incapacityreason = workaccident), the date of the work accident. In the case of an Occupational disease (incapacityreason = occupationaldisease), the request date for a dossier for occupational disease. Format : date |
|||
[content (text)] Extra indications for this specific incapacity, in free text Format : text |
|||
[beginmoment] Specifies when the incapacity starts. Format : date |
|||
[endmoment] Specifies when the current period of incapacity ends. Format : date |
|||
diagnosis |
1 |
Describes the diagnosis that is the reason for this incapacity. This information is ONLY allowed in the incapacity transaction for Medex! |
[content (cd)] A coded form of the diagnosis. |
[content (text)] A text with the description of the diagnosis. |