POST api/v1/patients/{id}/journals?domain={domain}&key={key}&provider_unit={provider_unit}&roles={roles}
Saves a new journal
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
The social security number (DDMMYYXXXXX, e.g. 11118793456) or internal patient Id in EPJ |
string |
Required |
domain |
The domain ID. This is the name of the municipality's meta domain that the API is reading writing data to. |
string |
Required |
key |
The API license key. |
string |
Required |
provider_unit |
Not in use |
string |
None. |
roles |
Not in use |
string |
None. |
Body Parameters
The journal to store
JournalName | Description | Type | Additional information |
---|---|---|---|
JournalType |
Int value to specify which journal type this is. In Gerica, visible as JournalType in Journalliste |
integer |
Required |
EmployeeId |
SSN or GericaID of the Employee. |
string |
Required |
Registered |
When the client was last updated. Saved the date as local time on the server. Save journal registration time converted to the local time on the server. Daylight savings time is also taking in to account. So if the time setting on the server is UTC + 1 and daylight saving time is on then "2020-04-19T11:00:00+02:00" saved on the server as 2020.04.19:11:00 With the same server settings and new "Registered value" is 2020-04-19T11:00:00+03:00 then it's saved as 2020.04.19:10:00 on the server. UTC can also be used as input. With the same server settings and new "Registered value" is 2020-04-19T11:00Z is sent as Registered time then this is saved as 20.04.2020 13:00:00 See ISO 8601 for more information about the time format. In Gerica, visible in the Journal as both fra dato/kl and til dato/kl. Update from 9.1.10: Allow (should be) null if StartTime is set. Exactly one of Registered and StartTime must be given. |
date |
None. |
StartTime |
When given, this will be the StartTime of the new journal record. If null, then Registered should be set. Accepts the same date time format as Registered. New in 9.1.10 |
date |
None. |
EndTime |
End time of the journal record. If not null, then StartTime should also be set (and thus, Registered should be null). Accepts the same date time format as Registered. New in 9.1.10 |
date |
None. |
Text |
Additional text to the journal. Free text, can include linebreaks. |
string |
None. |
CareServiceId |
Required parameter for some journal types. Optional parameter for other journal types. Id to the CareService (tjeneste) the journal should be connected to. If this parameter is not set then the CareService name will is not shown in the EPJ. e.g if the "CareServiceId" set to: 17776 then EPJ will know that the CareService is "Hjemmesykepleie" (This can differ from system to system, only an example) See CareService API for details on how to obtain this value. /patients/{id}/careServices will return this field as CareserviceId |
integer |
None. |
CareServiceCode |
Optional parameter. A levelstring representing a Task (tiltak) that will be connected to the journal. Sub-levels from CareService API is allowed. If this parameter is not set then EPJ will not know details about care service performed e.g if the CareServiceCode is set to "15.1.7". Then EPJ knows that the CareService performed is "Personlig pleie - Ut av eller opp i send" (This can differ from system to system, only an example) Values can be fetched as PlannedAction from /patients/{id}/careServices. |
string |
None. |
Request Formats
application/json, text/json
{ "JournalType": 15, "EmployeeId": "1", "Registered": "2024-11-22T20:23:16.9679425+01:00", "StartTime": null, "EndTime": null, "Text": "JournalText", "CareServiceId": 17715, "CareServiceCode": "15.1" }
application/xml, text/xml
<Journal xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://lifecare.tieto.com/ec/no/v1"> <CareServiceCode>15.1</CareServiceCode> <CareServiceId>17715</CareServiceId> <EmployeeId>1</EmployeeId> <EndTime i:nil="true" /> <JournalType>15</JournalType> <Registered>2024-11-22T20:23:16.9679425+01:00</Registered> <StartTime i:nil="true" /> <Text>JournalText</Text> </Journal>
Response Information
Resource Description
Saves a new journal
stringResponse Formats
application/json, text/json
"sample string 1"
application/xml, text/xml
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>