Journal notes

Planned feature for SFM version 4

SFM will create journal notes suitable for inclusion to the EHR/EPJ Journal. The concept is based on a "virtual encounter", and the EHR is responsible for the management of encounter references.

In the setPatient function provided in the postMessage (workspace integration) the EHR will present an encounterIdentifier=<uniqe string> This identifier will be registered by the subsequent envets in SFM, made available by Datashare API through a query on Basic.

SFM client will notify parent frame whenever there is new events available by issuing a postMessage to the parent frame:

{
	"action" : "journalUpdate",
	"encounterIdentifier" : "<encounterIdentifier from setPatient>",
}

Profile

SFM journal note

idΣ0..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
JournalNoteI1..1Extension(Complex)
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
id0..1
extensionI0..*Extension
textΣ0..0string
subjectΣ I0..0Reference(Resource)
createdΣ0..1date
authorΣ I0..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization)

Extension

SFM Journal note extension

id0..1
id0..1
extensionI0..*Extension
url1..1Fixed Value
valueDateTimedateTime
id0..1
extensionI0..*Extension
url1..1Fixed Value
id0..1
extensionI0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
id0..1
extensionI0..*Extension
url1..1Fixed Value
id0..1
extensionI0..*Extension
useΣ ?!0..0codeBinding
typeΣ0..0CodeableConceptBinding
systemΣ0..0uri
valueΣ0..1string
periodΣ I0..0Period
assignerΣ I0..0Reference(Organization)
id0..1
extensionI0..*Extension
url1..1Fixed Value
id0..1
extensionI0..*Extension
referenceΣ I0..1string
typeΣ0..1sfm-MedicationStatement, sfm-NutritionStatement, sfm-BandaPrescriptionBinding
identifierΣ0..1Identifier
displayΣ0..1string
valueReferenceReference()
id0..1
extensionI0..*Extension
url1..1Fixed Value
valueStringstring
id0..1
extensionI0..*Extension
url1..1Fixed Value
valueStringstring
id0..1
extensionI0..*Extension
url1..1Fixed Value
valueStringstring
url1..1Fixed Value

The extension has a type with a value from the code set sfm-journalnote-types indicating the category. The EHR may use this for filtering.

Retreival on Datashare

The actual retreival of journal note candidates is performed using a named query on Basic. Parameter may be the registered encounterIdentifier or a combination of patientTicket and timestamp:

GET [base]/Basic?_query=JOURNALNOTE&encounterIdentifier=(identifier given above)
GET [base]/Basic?_query=JOURNALNOTE&patientTicket=(ticket)&modified=gt(timestamp)

Note that SFM will return all items matching an encounterIdentifier by the first varient, and the number of items will grow during a typical session.