Page Comparison

The following use case will allow a partner to query for a list of ServiceRequests that where were assigned to them by the CIE Hub. Currently the use case is that if , a Michigan 211 operator call center agent can create and assign a ServiceRequest to a partner. In this situation the Hub will create a ServiceRequest with the performer field set to the partner Organization.

Resources that will be returned in this example

Resource	Description	FHIR Reference
ServiceRequest	This represents the Request from a partner system. The performer of this ServiceRequest should be your organization.	https://build.fhir.org/servicerequest.html
Patient	Represents information on the person that has be referred by the partner organization.	https://build.fhir.org/patient-definitions.html
Procedure	If the referring partner had made any other referrals during the process of creating the Service Request they will be found in the Procedure resources. For example if the client was referred to a food pantry during this ServiceRequest that will represented by a Procedure resource.	https://build.fhir.org/procedure.html

Performer Attribute

The following is a example of a performer attribute holds the information of the organization that is filled in

...

performing the service. The data can be stored in two different approaches. One approach is using and integrating the social services directory id’s. The other approach is to use a ID that is CIE Hub ID.

The following is a example of a performer attribute that is filled in

Code Block

   //The following example shows using the Social Services Directory
   //ID 
   "referenceperformer": "Organization/39", // This will be the ID that is given during Setup [
    {
      "display": "MISSION FOR AREA PEOPLE",
      "typeextension" : "Organization"[
          }
  ],

Example of search

The following search will get a list of the current active ServiceRequests that are assigned to the partner organization and also return the list of Patients that correspond to those ServiceRequests and any resources that the service request was based on.

Code Block
GET https://fhir.mi-cie.org/ServiceRequest ?performer=Organization/{PARTNERID} &status=active &_include=ServiceRequest:based-on &_include=ServiceRequest:subject &_revinclude=Procedure:based-on

The result of this query would be a bundle of resources. Here is a link for a example on the FHIR site of a bundle search response.

https://build.fhir.org/bundle-example.json.html

CIE Hub Example of ServiceRequest

Code Block

{
  "authoredOn": "2023-07-18T10:40:53-04:00",
  "category": [
    {
      "coding": [
        {
          "code": "transportation-insecurity",
          "display": "Transportation Insecurity",
          "system": "http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes"
        },{
              "url" : "https://directory.mi-cie.org/or_org_id",
              "valueString": "24828"
          }
      ]  
    }
  ],
  
  //The following example shows using CIE Hub ID.  
  "performer": [
    {
      "display": "United Way",
      "reference": "Organization/39", // This will be the ID that is given during Setup
      "type": "Organization"
    }
  ],

Example of search

The following search will get a list of the current active ServiceRequests that are assigned to the partner organization and also return the list of Patients that correspond to those ServiceRequests and any resources that the service request was based on.

Code Block

// Example of a search using the CIE Organization ID
GET https://fhir.mi-cie.org/ServiceRequest
?performer=Organization/{PARTNERID}
&status=active
&_include=ServiceRequest:based-on
&_include=ServiceRequest:subject 
&_revinclude=Procedure:based-on

// Example of a search using Social Services Directory ID
GET https://fhir.mi-cie.org/ServiceRequest
?performer_or_org_id={ORGID}
&status=active
&_include=ServiceRequest:based-on
&_include=ServiceRequest:subject 
&_revinclude=Procedure:based-on

The result of this query would be a bundle of resources. Here is a link for a example on the FHIR site of a bundle search response.

https://build.fhir.org/bundle-example.json.html

CIE Hub Example of ServiceRequest

Code Block

{
  "authoredOn": "2023-07-18T10:40:53-04:00",
  "category": [
    {
      "coding": [
        {
          "code": "GeneratedRideUnitedForm_v2transportation-insecurity",
          "display": "RideTransportation United EnrollmentInsecurity",
          "system": "httpshttp://mi-ciehl7.org/fhir/StructureDefinition/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes"
        }
      ]
 ,
  }   ],   "code": {
    "coding": [       {
        "code": "RideUnitedEnrollmentGeneratedRideUnitedForm_v2",
          "display": "Ride United Enrollment",
          "system": "https://mi-cie.org/fhir/StructureDefinition"
      }
    ]   },   "id": "569b48af-408b-4d50-83a4-89e6bbb7e2e4",}
   "intent": "original-order",  ]
"meta": {   }
 "lastUpdated": "2023-07-18T14:40:55.444498+00:00",
  ],
  "versionIdcode": "MTY4OTY5MTI1NTQ0NDQ5ODAwMA"{
  },
  "performercoding": [
      {
        "displaycode": "United way of South East Michigan"RideUnitedEnrollment_v2",
        "display": "Ride United Enrollment",
        "referencesystem": "Organization/UWSEM",https://mi-cie.org/fhir/StructureDefinition"
      "type": "Organization"}
    ]
}   ]},
  "requesterid": {
 "569b48af-408b-4d50-83a4-89e6bbb7e2e4",
  "displayintent": "Samaritasoriginal-order",
  "meta": {
    "referencelastUpdated": "Organization/fa4e217e-38fa-4aeb-9e2d-938422aa39482023-07-18T14:40:55.444498+00:00",
    "typeversionId": "OrganizationMTY4OTY5MTI1NTQ0NDQ5ODAwMA"
  },
  "resourceTypeperformer": "ServiceRequest", [
    {
      "statusdisplay": "active",
  "subject": {United way of South East Michigan",
      "displayreference": "Steve WinwoodOrganization/UWSEM",
      "referencetype": "Patient/e4744733-9061-478f-bd6a-84f75df90c66"Organization"
   } }

CIE Example of a Patient

The following is a example of a patient

Code Block

{
  "active": true],
  "addressrequester": [{
    {
 "display": "Samaritas",
    "cityreference": "RochesterOrganization/fa4e217e-38fa-4aeb-9e2d-938422aa3948",
 
    "districttype": "OaklandOrganization",
   },
  "lineresourceType": ["ServiceRequest",
  "status": "active",
    "subject"1234 North Main Street": {
    "display": "Steve ]Winwood",
 
    "postalCodereference": "48307",Patient/e4744733-9061-478f-bd6a-84f75df90c66"
  }
}

CIE Example of a Patient

The following is a example of a patient

Code Block

{
  "stateactive": true,
  "MI",address": [
    {
      "textcity": " 1234 North Main Street, Rochester, MI, United States",
      "typedistrict": "physicalOakland",
      "useline": "old"[
    }   ], "1234 North "birthDate":Main "1972-03-11",
Street"
 "communication": [     {],
      "languagepostalCode": {
 "48307",
      "codingstate": ["MI",
      "text": " 1234 North {Main Street, Rochester, MI, United States",
       "codetype": "en-USphysical",
            "display"use": "English"
     old"
    }
  ],
  "birthDate": "1972-03-11",
 ] "communication": [
    },{
      "preferredlanguage": true{
    }   ],
  "extensioncoding": [
 
  {       "url": "http://hl7.org/fhir/StructureDefinition/patient-preferenceType",    {
      "valueString": "Text Message"     }"code": "en-US",
    {        "urldisplay": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",English"
          }
 "valueString": "Black / African American"   ]
 },     {},
      "urlpreferred": "http://hl7.org/fhir/us/military-service/StructureDefinition/military-service-veteran-status",true
     }
"valueBoolean": false ],
   },"extension": [
    {
      "url": "httpshttp://mi-ciehl7.org/fhir/StructureDefinition/familypatient-memberpreferenceType",
      "valueString": "{\"firstName\":\"Bianca\",\nText Message"
             \"lastName\":\"King\"\n },
     {
      ,\"birthDate\url":\"1974-05-11\"} "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
      "valueString": "Black / African American"
    },
    {
      "url": "httpshttp://mi-ciehl7.org/fhir/us/military-service/StructureDefinition/modifiedmilitary-service-byveteran-userstatus",
      "valueStringvalueBoolean": "cleovra.harper-perkins@liveunitedsem.org"false
    },
  ],  {
  "gender": "male",   "idurl": "09db5e93-a7e4-4083-9848-ce67cedc5fe9https://mi-cie.org/fhir/StructureDefinition/family-member",
  "meta": {     "lastUpdatedvalueString": "2023-07-18T17:56:47.946887+00:00","{\"firstName\":\"Bianca\",\n     "versionId": "MTY4OTcwMzAwNzk0Njg4NzAwMA"      },   "name": [\"lastName\":\"King\"\n       {       ,\"familybirthDate\": "King",\"1974-05-11\"}"
    },
 "given": [  {
      "Rogerurl"
      ]: "https://mi-cie.org/fhir/StructureDefinition/modified-by-user",
      "usevalueString": "officialcleovra.harper-perkins@liveunitedsem.org"
    }
  ],
  "resourceTypegender": "Patientmale",
  "telecomid": ["09db5e93-a7e4-4083-9848-ce67cedc5fe9",
   "meta": {
    "lastUpdated":  "rank": 1,
 "2023-07-18T17:56:47.946887+00:00",
    "systemversionId": "phoneMTY4OTcwMzAwNzk0Njg4NzAwMA",
   },
  "usename": "mobile", [
    {
      "valuefamily": "(248) 333-5500"King",
    },  "given": [
 {       "rankRoger": 2,
      "system": "sms"],
      "use": "mobileofficial",
    }
  ],
  "valueresourceType": "(248) 333-5555"Patient",
  "telecom": [
},
    {
      "rank": 21,
      "system": "emailphone",
      "use": "homemobile",
      "value": "123@yahoo.com(248) 333-5500"
    },
  ]
}

CIE Example of a Procedure

Code Block

{  {
      "basedOnrank": 2,
  [     {"system": "sms",
      "referenceuse": "ServiceRequest/g89ac064-7a32-4aef-9c0d-a3c47672cc09mobile",
      "typevalue": "ServiceRequest(248) 333-5555"
    },
  ],  {
"category": {     "codingrank": [2,
      {
"system": "email",
       "codeuse": "service-categoryhome",
 
      "displayvalue": "service category",123@yahoo.com"
    }
  ]
}

CIE Example of a Procedure

Code Block

{
 "system": "https://mi-cie.org"basedOn": [
    {
 }     ],"reference": "ServiceRequest/g89ac064-7a32-4aef-9c0d-a3c47672cc09",
      "texttype": "TransportationServiceRequest"
    }
  ],
  "codecategory": {
    "coding": [
      {
        "code": "service-category",
        "codedisplay": "SocialServiceReferral_v2service category",
        "displaysystem": "Social Service Referred","https://mi-cie.org"
      }
    ],
    "systemtext": "https://mi-cie.org"
"Transportation"
  },
  "code": {
    "coding": [
     } {
   ],     "textcode": "Email"SocialServiceReferral_v2",
    },    "extensiondisplay": ["Social Service  Referred",
 {       "urlsystem": "https://mi-cie.org/fhir/StructureDefinition/HealthcareServiceId",
      "valueInteger": 78856
    },
 
  {  ],
    "urltext": "https://mi-cie.org/fhir/StructureDefinition/HealthcareServiceLocationName",Email"
   },
  "valueStringextension": "NANKIN[
TRANSIT COMMISSION"    {
}   ],   "idurl": "a42c6d64-a622-45eb-93f8-e26a595a4f71",https://mi-cie.org/fhir/StructureDefinition/HealthcareServiceId",
      "metavalueInteger": 78856
    },
    {
      "lastUpdatedurl": "2023-06-19T15:58:06.080132+00:00",
    "versionId": "MTY4NzE5MDI4NjA4MDEzMjAwMA"
  },https://mi-cie.org/fhir/StructureDefinition/HealthcareServiceLocationName",
      "notevalueString": [
"NANKIN TRANSIT COMMISSION"
   { }
  ],
  "authorReferenceid": {"a42c6d64-a622-45eb-93f8-e26a595a4f71",
  "meta": {
    "displaylastUpdated": "Amanda Russo",
   2023-06-19T15:58:06.080132+00:00",
    "referenceversionId": "Practitioner/e906e843-2f14-48a7-990c-2ad342d366f7MTY4NzE5MDI4NjA4MDEzMjAwMA"
  },
   },"note": [
    {
  "text": "here is that resource"authorReference",: {
     "time": "2023-06-19T11:58:04-04:00"
    "display": "Amanda Russo",
  }   ],   "performedDateTimereference": "2023-06-19T11:58:04-04:00",
  "recorder": {Practitioner/e906e843-2f14-48a7-990c-2ad342d366f7"
      },
      "displaytext": "Amanda Russohere is that resource",
      "referencetime": "Practitioner/e906e8432023-2f14-48a7-990c-2ad342d366f7"06-19T11:58:04-04:00"
    },
  "resourceType": "Procedure"],
  "statusperformedDateTime": "in-progress2023-06-19T11:58:04-04:00",
  "subjectrecorder": {
    "display": "RECORDAmanda FHIRRusso",
    "reference": "PatientPractitioner/314aeb5ce906e843-df582f14-45fc48a7-8d07990c-fd1f326c8f4b2ad342d366f7"
  }
}

Updating the status of the ServiceRequest once it has been completed

To make sure that the status of your service requests are up to data you will need to update the status of the service request through a PATCH method.

The following is the example of a PATCH url and body for this operation

Code Block

PATCH https://fhir.mi-cie.org/fhirR4/ServiceRequest/{SERVICEREQUEST_ID}

BODY will be
[{op: 'replace', path: '/status', value: 'completed'}]},
  "resourceType": "Procedure",
  "status": "in-progress",
  "subject": {
    "display": "RECORD FHIR",
    "reference": "Patient/314aeb5c-df58-45fc-8d07-fd1f326c8f4b"
  }
}

Versions Compared

Old Version 4

New Version Current

Key

Resources that will be returned in this example

Performer Attribute

Example of search

CIE Hub Example of ServiceRequest

Example of search

CIE Hub Example of ServiceRequest

CIE Example of a Patient

CIE Example of a Patient

CIE Example of a Procedure

CIE Example of a Procedure

Updating the status of the ServiceRequest once it has been completed