Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
{
  "subject": {
    "identifiers": {
      "mrn": "1234567890",
      "cks": "1234445"
    },
    "person" : {
      "personId": "2af239fc-fa74-4f89-b01e-53263c11ec9b",
      "name": {
        "family": "Springsteen", 
        "given": "Bruce",
        "middle": ""
      },
      "sex": "F",
      "birthTime": "19410101", 
      "address": {
        "streetAddressLine": "111 Main Street",
        "streetAddressLine2": "",
        "city": "Spring Creek",
        "state": "MI",
        "postalCode": "49456"
      },
      "contacts": { 
        "mobilePhone": "+16161231234",
        "homePhone": "+16161231234",
        "email": "john.doe@gamil.com"
      }  
    }
  },
  "outcome": {
        "referralId": "bca4ce01-6ec2-4467-90b5-a9dd0776d6f5",
        "outcomeId": "f16c709e-481c-4bf4-893e-84ceb1761217",
        "createdFromAssessmentId": "123414", // This will be the value that is being passed in
        "dateTime": "2/4/2020 10:26:00 AM",
        "domain": "EconomicFood StabilityInsecurity",
        "subDomain": "Food Insecurity",
        "organizationName": "Fish and Loaves Foodbank",
        "status": "Complete", 
		"notes" : "Provision - Provision of Food"
	}
}

...

serviceName

Data Element

Description

Required

Identifiers

mrn

This will be the Medical Record Number of the person that received the social service

Tip

X

cks

This will be the MIHN record number of the person that received the social service

Person

personId

This will be the id that the Community of Information Exchange has assigned the person.

 

name.family

name.middle

name.given

This represents the name of the person that received the service.

 

sex

The gender of the person.

 

birthTime

The birthTime of the user. The format of this will be

YYYYMMDD

 

address.streetAddressLine

address.streetAddressLine2

address.city

address.state

address.postalCode

This represents the address of the person that received the service.

 

contacts.mobilePhone

contacts.homePhone

contacts.email

The contact information of the person that receives the service.

 

Outcome

referralId

This represents the referralId that is associated with the outcome. When a referral is made to the CIE a referralId is created. Currently for Henry Ford Health System this is the value that is returned when a HL7 message is received.

 

outcomeId

This represents an outcome Id that the CIE assigns when a service has been given to the user.

 

createdFormAssessmentId

This is the assessment id that was sent in the original referral that was sent in the HL7 message.

dateTime

The date and time the service was given to the person. This will be in the ISO Date time format

domain

This represents the SDOH domain. The domains can be found in this link

https://www.healthypeople.gov/2020/topics-objectives/topic/social-determinants-health/interventions-resources

subDomain

This represents the SDOH subdomain. The subdomains can also be found in this link

https://www.healthypeople.gov/2020/topics-objectives/topic/social-determinants-health/interventions-resources currently being sent is

Food Insecurity

subDomain

Current this is not being used

organizationName

The name of the organization that performed the service.

The name of the service that was performed.

status

The status of outcome.

notes

Any notes that have been provided on this outcome.

...

Status

Description

Example of Outcome Node in Object

Received

This will be when we have received and processed the referral from Henry Ford. I would assume that this will come back within a minute of Henry Ford submitting the referral.

Code Block
  "outcome": {
        "referralId": "bca4ce010b5-a9dd0776d6f5",
        "outcomeId": "f499b1a1-7f67-42de-8457-7c5a0cb55568", // No Outcome
ID from the Hub
        "createdFromAssessmentId": "12345667", // This will be the value that is being passed in
        "dateTime": "2/4/2020 10:26:00 AM2011-10-05T14:48:00.000Z", // DateTime the Referral was processed by CIE Hub
        "domain": "Food Insecurity",
        "subDomain": "",
        "organizationName": "",
        "status": "Received", 
		"notes" : ""
	}

Work Started

This will be when a social navigator from the United Way has started to work on this case.

Code Block
  "outcome": {
        "referralId": "bca4ce010b5-a9dd0776d6f5",
        "outcomeId": "", // No Outcome ID from the Hub56d1d1e0-0274-4851-b99a-747e31282936", 
        "createdFromAssessmentId": "12345667", // This will be the value that is being passed in
        "dateTime": "2/4/2020 10:26:00 AM2011-10-05T14:48:00.000Z", // Work Started Time
        "domain": "Food Insecurity",
        "subDomain": "",
        "organizationName": "",
        "status": "Work Started", 
		"notes" : ""
	}

Assistance Initiated/Scheduled

A appointment has been scheduled for the person. Please note that the dateTime when the appointment was confirmed and scheduled. The notes will have the time the appointment is scheduled.

Code Block
  "outcome": {
        "referralId": "bca4ce010b5-a9dd0776d6f5",
        "outcomeId": "cca4ce010b5-a9dd0776d6f5", // No Outcome ID from the Hub
        "createdFromAssessmentId": "12345667", // This will be the value that is being passed in
        "dateTime": "8/4/2021 10:30:00 AM2011-10-05T14:48:00.000Z", // DateTime appointment was scheduled for
        "domain": "EconomicFood StabilityInsecurity",
        "subDomain": "Food Insecurity",
        "organizationName": "Fish and Loaves Food Pantry",
        "status": "Assistance Initiated/Scheduled", 
		"notes" : "Appointment was scheduled on 8/6/2021 10:45:00 AM"
	}

Complete

The person has received the service.

Code Block
  "outcome": {
        "referralId": "bca4ce010b5-a9dd0776d6f5",
        "outcomeId": "caddca4ce010b5-a9dd0776d6f5", 
        "createdFromAssessmentId": "12345667", // This will be the value that is being passed in
        "dateTime": "7/4/2021 10:26:00 AM2011-10-05T14:48:00.000Z", // DateTime the service was rendered
        "domain": "EconomicFood StabilityInsecurity",
        "subDomain": "Food Insecurity",
        "organizationName": "Fish and Loaves Food Pantry",
        "status": "Complete", 
		"notes" : "Provision - Provision of Food" // This is the intervention from the gravity project
	}

Unable to Meet Need

We where unable to help the person that was referred to the CIE Hub

Code Block
  "outcome": {
        "referralId": "bca4ce010b5-a9dd0776d6f5",
        "outcomeId": "", // No Outcome ID from the Hub
        "createdFromAssessmentId": "12345667", // This will be the value that is being passed in
        "dateTime": "7/4/2020 10:26:00 AM2011-10-05T14:48:00.000Z", // DateTime the referral was closed in the CIE Hub
        "domain": "EconomicFood StabilityInsecurity",
        "subDomain": "Food Insecurity",
        "organizationName": "",
        "status": "Unable To Meet Need", 
		"notes" : ""
	}

...