This document is in draft mode and still in development.
The following will be the payload that will be sent back to Henry Ford Health System when a outcome has been completed for a patient that was referred to the CIE Hub.
Authorization
A client certificate will be generated for Michigan CIE hub. This will then be used on each of the calls.
Request
The following will be the request object that will be sent in the body of the post. The information in the request will represent the information that will be needed to create the outcome in the CIE Hub.
Request Use Case (A outcome or a status change has been generated by the CIE)
When an outcome or a status change has been gathered from a service provider this JSON payload will be sent to Health System that initially provided the referral to the CIE.
{
"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": "Economic Stability",
"subDomain": "Food Insecurity",
"organizationName": "Fish and Loaves Foodbank",
"status": "Complete",
"notes" : "Provision - Provision of Food"
}
}
Data Definition
The following defines the attributes that will be in the request body.
Data Element | Description | Required |
|---|---|---|
Identifiers | ||
mrn | This will be the Medical Record Number of the person that received the social service | 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. | |
domain | This represents the SDOH domain. The domains can be found in this link | |
subDomain | This represents the SDOH subdomain. The subdomains can also be found in this link | |
organizationName | The name of the organization that performed the service. | |
serviceName | The name of the service that was performed. | |
status | The status of outcome. | |
notes | Any notes that have been provided on this outcome. | |
Status
The following will be the status and when we will send back to the system that referred the person to the CIE Hub.
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. | "outcome": {
"referralId": "bca4ce010b5-a9dd0776d6f5",
"outcomeId": "", // 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 AM", // DateTime the Referral was processed by CIE Hub
"domain": "",
"subDomain": "Food Insecurity",
"organizationName": "",
"status": "Received",
"notes" : ""
}
|
Work Started | This will be when a social navigator from the United Way has started to work on this case. | "outcome": {
"referralId": "bca4ce010b5-a9dd0776d6f5",
"outcomeId": "", // 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 AM", // Work Started Time
"domain": "",
"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. | "outcome": {
"referralId": "bca4ce010b5-a9dd0776d6f5",
"outcomeId": "", // 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 AM", // DateTime appointment was scheduled for
"domain": "Economic Stability",
"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. | "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 AM", // DateTime the service was rendered
"domain": "Economic Stability",
"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 | "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 AM", // DateTime the referral was closed in the CIE Hub
"domain": "Economic Stability",
"subDomain": "Food Insecurity",
"organizationName": "",
"status": "Unable To Meet Need",
"notes" : ""
}
|
Add Comment