Flat File Integrations - External Observations

File Name

When sending the file to the server it should be named using the following format: "observations_{timestamp}.csv"

Which Data

Any data that can be mapped to a Mirah assessment (see below). Note that Observations include only the final value, and not any individual item responses used to generate the final result.

Data Fields

NOTE: Please follow all field name and note formats, including case sensitivity.

Item Field name Format Req’d Notes
Id identifiers string Y Unique ID for the observation
Subject Id subjectId string Y This should be a guaranteed-unique identifier for the patient in your EHR that is associated with the caregiver
Effective Date effectiveDate FHIR dateTime Y The date the observation was completed
Code code string Y The code representing the assessment that was completed. Please see “Assessment Codes” below
Value (Float) valueFloat float N One of valueFloat, valueInt and valueString is required. The value of the assessment
Value (Int) valueInt integer N One of valueFloat, valueInt and valueString is required. The value of the assessment
Value (String) valueString string N One of valueFloat, valueInt and valueString is required. The value of the assessment
Performer performer FHIR reference N

If left blank, the performer is assumed to be the patient. 


Will accept FHIR references for Patient, RelatedPerson, and Practitioner, e.g.:


Patient/123

RelatedPerson/456

Practitioner/789

Note note string N Any notes to be displayed with the observation
Interpretation interpretation string N The interpretation of the result, in string format.
Encounter Id encounterId string N The identifier of the encounter to associate this measurement with

Assessment Codes


Mirah supports over 400 assessments. We support three different mechanisms for matching:

  • LOINC codes - e.g. 44261-6 for the PHQ9
  • Mirah’s unique assessment code. Examples include ‘phq9’, ‘gad7’, ‘sfss’, etc. A full code mapping can be provided on request.
  • A custom mapping agreed with our support team as part of implementation.

For customers using just the PHQ9 and GAD7, they may use the string ‘phq9’ for PHQ9 and ‘gad7’ for GAD7.