Update (11/17): Changed Category to optional, and When to approx-datetime
Update (1/25): Based on further feedback we decided to create two types – Health Journal Entry (focused on enabling a user to journal daily health experiences) and Comment (focused on enabling a user to annotate on existing Health items). We are also removing the Note-Attachments element to keep the type simple.

A number of partner scenarios have warranted us to create a type which stores a free-form Health Note.

Having a health note type will enable number of interesting scenarios like the patient being able to take general health notes pertaining to a specific category for e.g mental health. Additionally a user can use this type to jot down rich multimedia notes for e.g take an audio note from doctor while being in an appointment.

Following is the current thinking with regards to the schema for this type.

Note

Element

Type

Information

Notes

Occurrence

Required

Category

t-codable-value

Kind of information being recorded e.g. Mental Health

Vocabulary for Health-Notes-category. Our use-cases suggest one category per Note.


1..1

No

Content

string

Health note e.g. Was feeling a little giddy this morning, looking forward to soccer game in the evening.

Note belong to a particular category, and is plain text only.


1..1

Yes

When

d-approx-datetime

When this note was recorded

  1..1

Yes

Attachments note-attachments Any other information associated with the note e.g pictures or audio or video The rendering of attachment is defined in the mime type of the attachment blob. 0..n No

 

Note-Attachments

Element

Type

Information

Notes

Occurrence

Required

Blob-Name

string

Blob associated with this attachment e.g. Picture of my broken arm.

Blobs are already part of the base thing type
1..1

Yes

Description

string

Description of the blog e.g. This is picture of my broken arm.

 
1..1

Yes

Example

   1:  <note>
   2:  <category>
   3:    <text>Physician Visit</text>
   4:    <code>
   5:      <value>PhysicianVisit</value>
   6:      <family>wc</family>
   7:      <type>health-notes-category</type>
   8:      <version></version>
   9:    </code>
  10:  </category>
  11:    <content>Annual checkup note, need to work on weight. Details in attached audio.</content>
  12:    <when>
  13:      <date><y>2011</y><m>1</m><d>1</d></date>
  14:      <time><h>6</h><m>0</m><s>0</s><f>0</f></time>
  15:    </when>
  16:    <note-attachment>
  17:      <blob-name>physician visit</blob-name>
  18:      <description>Audio from Dr. John's annual checkup.</description>
  19:    </note-attachment>
  20:  </note>

 

Please let us know your feedback.

We will appreciate any other use cases which this type can solve. Examples and appropriate data will help us as well.