Versions Compared

Key

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

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 ServcieRequest 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 performer attribute holds the information of the organization that is 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 
   "performer": [
    {
      "display": "MISSION FOR AREA PEOPLE",
      "extension" : [
          {
              "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": "transportation-insecurity",
          "display": "Transportation Insecurity",
          "system": "http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes"
        },
        {
          "code": "GeneratedRideUnitedForm_v2",
          "display": "Ride United Enrollment",
          "system": "https://mi-cie.org/fhir/StructureDefinition"
        }
      ]
    }
  ],
  "code": {
    "coding": [
      {
        "code": "RideUnitedEnrollment_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",
    "versionId": "MTY4OTY5MTI1NTQ0NDQ5ODAwMA"
  },
  "performer": [
    {
      "display": "United way of South East Michigan",
      "reference": "Organization/UWSEM",
      "type": "Organization"
    }
  ],
  "requester": {
    "display": "Samaritas",
    "reference": "Organization/fa4e217e-38fa-4aeb-9e2d-938422aa3948",
    "type": "Organization"
  },
  "resourceType": "ServiceRequest",
  "status": "active",
  "subject": {
    "display": "Steve Winwood",
    "reference": "Patient/e4744733-9061-478f-bd6a-84f75df90c66"
  }
}

CIE Example of a Patient

The following is a example of a patient

Code Block
{
  "active": true,
  "address": [
    {
      "city": "Rochester",
      "district": "Oakland",
      "line": [
        "1234 North Main Street"
      ],
      "postalCode": "48307",
      "state": "MI",
      "text": " 1234 North Main Street, Rochester, MI, United States",
      "type": "physical",
      "use": "old"
    }
  ],
  "birthDate": "1972-03-11",
  "communication": [
    {
      "language": {
        "coding": [
          {
            "code": "en-US",
            "display": "English"
          }
        ]
      },
      "preferred": true
    }
  ],
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/patient-preferenceType",
      "valueString": "Text Message"
    },
    {
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
      "valueString": "Black / African American"
    },
    {
      "url": "http://hl7.org/fhir/us/military-service/StructureDefinition/military-service-veteran-status",
      "valueBoolean": false
    },
    {
      "url": "https://mi-cie.org/fhir/StructureDefinition/family-member",
      "valueString": "{\"firstName\":\"Bianca\",\n              \"lastName\":\"King\"\n              ,\"birthDate\":\"1974-05-11\"}"
    },
    {
      "url": "https://mi-cie.org/fhir/StructureDefinition/modified-by-user",
      "valueString": "cleovra.harper-perkins@liveunitedsem.org"
    }
  ],
  "gender": "male",
  "id": "09db5e93-a7e4-4083-9848-ce67cedc5fe9",
  "meta": {
    "lastUpdated": "2023-07-18T17:56:47.946887+00:00",
    "versionId": "MTY4OTcwMzAwNzk0Njg4NzAwMA"
  },
  "name": [
    {
      "family": "King",
      "given": [
        "Roger"
      ],
      "use": "official"
    }
  ],
  "resourceType": "Patient",
  "telecom": [
    {
      "rank": 1,
      "system": "phone",
      "use": "mobile",
      "value": "(248) 333-5500"
    },
    {
      "rank": 2,
      "system": "sms",
      "use": "mobile",
      "value": "(248) 333-5555"
    },
    {
      "rank": 2,
      "system": "email",
      "use": "home",
      "value": "123@yahoo.com"
    }
  ]
}

CIE Example of a Procedure

Code Block
{
  "basedOn": [
    {
      "reference": "ServiceRequest/g89ac064-7a32-4aef-9c0d-a3c47672cc09",
      "type": "ServiceRequest"
    }
  ],
  "category": {
    "coding": [
      {
        "code": "service-category",
        "display": "service category",
        "system": "https://mi-cie.org"
      }
    ],
    "text": "Transportation"
  },
  "code": {
    "coding": [
      {
        "code": "SocialServiceReferral_v2",
        "display": "Social Service Referred",
        "system": "https://mi-cie.org"
      }
    ],
    "text": "Email"
  },
  "extension": [
    {
      "url": "https://mi-cie.org/fhir/StructureDefinition/HealthcareServiceId",
      "valueInteger": 78856
    },
    {
      "url": "https://mi-cie.org/fhir/StructureDefinition/HealthcareServiceLocationName",
      "valueString": "NANKIN TRANSIT COMMISSION"
    }
  ],
  "id": "a42c6d64-a622-45eb-93f8-e26a595a4f71",
  "meta": {
    "lastUpdated": "2023-06-19T15:58:06.080132+00:00",
    "versionId": "MTY4NzE5MDI4NjA4MDEzMjAwMA"
  },
  "note": [
    {
      "authorReference": {
        "display": "Amanda Russo",
        "reference": "Practitioner/e906e843-2f14-48a7-990c-2ad342d366f7"
      },
      "text": "here is that resource",
      "time": "2023-06-19T11:58:04-04:00"
    }
  ],
  "performedDateTime": "2023-06-19T11:58:04-04:00",
  "recorder": {
    "display": "Amanda Russo",
    "reference": "Practitioner/e906e843-2f14-48a7-990c-2ad342d366f7"
  },
  "resourceType": "Procedure",
  "status": "in-progress",
  "subject": {
    "display": "RECORD FHIR",
    "reference": "Patient/314aeb5c-df58-45fc-8d07-fd1f326c8f4b"
  }
}