Introduction
This use case will focus on the calls that need to be made to submit a new service request through the CIE hub. The use case will demonstrate how to create a patient in the system and then submit the Service Request along with observations. Note that, while the term “patient” is used in this spec, the entity that is being created is any person or community member.
Resources that will be submitted in this use case
Resource | Description | FHIR Reference |
|---|---|---|
ServiceRequest | This represents the Request from a partner system. The performer of this ServiceRequest should be the referring organization. | |
Patient | Represents person demographic information to be referred by the partner organization. | |
Observation | Represents relevant information that is associated with a Service Request. This could be responses to a questionnaire or screening, or details associated with a specific need. |
Step 1 - Submit a Patient
Step one is to register a new patient within the Hub. Please note that if you have already submitted a patient you do not need to do this step again. The CIE hub also has the ability for the referring organization to share their unique identifiers to the record, enabling subsequent searches by using the referring org’s unique identifier. The following describes that process. Sharing your Unique Identifiers
The following is an example payload for a patient. This will return an identifier for the CIE Hub that can be used in the next bundle call.
| Code Block |
|---|
{
"active": true,
"address": [
{
"city": "Detroit",
"district": "Wayne",
"line": [
"1111 Test Street"
],
"postalCode": "48217",
"state": "MI",
"text": " 1111 Test Street, Detroit, MI, United States",
"type": "physical",
"use": "offical"
}
],
"birthDate": "1989-05-31",
"communication": [
{
"language": {
"coding": [
{
"code": "en-US",
"display": "English"
}
]
},
"preferred": true
}
],
"extension": [
{
"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": "http://hl7.org/fhir/StructureDefinition/patient-preferenceType",
"valueString": "Text Message"
}
],
"gender": "female",
"id": "cd521181-661f-480e-8d47-50ad810d712f",
"identifier": [
{
"system": "https://YOUR-URL.org",
"type": {
"text": "patientId"
},
"use": "official",
"value": "3058423"
}
],
"name": [
{
"family": "TESTER",
"given": [
"TEST"
],
"use": "official"
}
],
"resourceType": "Patient",
"telecom": [
{
"rank": 1,
"system": "phone",
"use": "mobile",
"value": "(313) 111-1111"
},
{
"rank": 2,
"system": "email",
"use": "home",
"value": "test@gmail.com"
}
]
} |
Here is the documentation on how to call the endpoint. POST Patient
Step 2 - Submit the ServiceRequest and Observations Bundle
Step two is to give information about the service request. This is done using a FHIR Bundle. The following describes a FHIR Bundle https://build.fhir.org/bundle.html .There will be two types of FHIR resources: the Service Request and the Observation. The following is an example of the Bundle.
Organization Id’s
For the requester and the performer of the Service Request a organization id will be needed. The CIE Hub is integrated with the MI211 Social Services and the organization id’s can be used to represent the requester and the performer. An extension can be used to use this MI211 social services organization id. This can be showed below.
| Code Block |
|---|
"performer": [
{
"display": "MISSION FOR AREA PEOPLE",
"extension" : [
{
"url" : "https://directory.mi-cie.org/or_org_id",
"valueString": "24828"
}
]
}
],
"resourceType": "ServiceRequest",
"requester": {
"display": "HACKLEY COMMUNITY CARE CENTER",
"extension" : [
{
"url" : "https://directory.mi-cie.org/or_org_id",
"valueString": "24571"
}
]
},
|
| Code Block |
|---|
{
"resourceType": "Bundle",
"type": "transaction",
"entry": [
{
"request": {
"method": "POST",
"url": "ServiceRequest"
},
"fullUrl": "urn:uuid:ec11f683-8779-4fcf-a9b7-1ce1b0033968",
"resource": {
"resourceType": "ServiceRequest",
"id": "ec11f683-8779-4fcf-a9b7-1ce1b0033968", //PLEASE GENERATE YOUR OWN GUID
"subject": {
"reference": "Patient/a41d9169-0dc9-4645-bc85-fbd3fafc4fee",
"display": "TEST TESTER"
},
"requester": {
"reference": "Organization/288859cf-ed33-4a41-85f1-ceba72f029dc",
"type": "Organization",
"display": "YOUR ORG" //This information will be given when registering to the Hub
},
"code": {
"coding": [
{ // Represents why the service request is being made
"code": "CODE",
"display": "FRIENDLY DISPLAY NAME",
"system": "https://mi-cie.org/fhir/StructureDefinition"
}
]
},
"extension": [ //THESE ARE OPTIONAL
{
"url": "http://hl7.org/fhir/StructureDefinition/referringName",
"valueString": "REFERRERFISTNAME"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/referringEmail",
"valueString": "referrer@referrer.com"
}
],
"status": "active",
"intent": "original-order",
"category": [
{ // REPRESENTS MORE METADATA ABOUT THE REQUEST- THIS IS OPTIONAL
"coding": [
{
"system": "http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes",
"code": "transportation-insecurity",
"display": "Transportation Insecurity"
}
]
}
],
"performer": [
{
"reference": "Organization/39649",
"type": "Organization",
"display": "PERFORMER ORGANIZATION"
}
],
"authoredOn": "2024-07-22T11:26:45-04:00"
}
},
{
"request": {
"method": "POST",
"url": "Observation"
},
"fullUrl": "urn:uuid:e7508fe8-a854-4a4d-a77a-6c89e6242f3f",
"resource": {
"resourceType": "Observation",
"basedOn": [
{
"reference": "ServiceRequest/ec11f683-8779-4fcf-a9b7-1ce1b0033968",
"type": "ServiceRequest"
}
],
"id": "a403eef1-df40-43ce-8d5c-8c10a7ca757b",
"status": "final",
"category": [
{ //Represents more meta data about the observation - This is optional
"coding": [
{
"system": "https://mi-cie.org/fhir/StructureDefinition",
"code": "CODE_v2",
"display": "FRIENDLY CODE NAME"
}
]
}
],
"code": {
"coding": [
{ // THIS REPRESENTS WHAT THE OBSERVATION IS
"system": "https://mi-cie.org/fhir/StructureDefinition/employmentEligibility",
"code": "employmentEligibility_v2",
"display": "Employment Eligibility"
}
]
},
"subject": {
"reference": "Patient/a41d9169-0dc9-4645-bc85-fbd3fafc4fee",
"display": "PUTFIRSTNAME PUTLASTNAME"
},
"valueString": "Job searching",
"effectiveDateTime": "2024-07-22T11:26:45-04:00"
}
},
{
"request": {
"method": "POST",
"url": "Observation"
},
"fullUrl": "urn:uuid:1d6d50dc-8e2e-418a-999f-dc3a9382ae5a",
"resource": {
"resourceType": "Observation",
"basedOn": [
{
"reference": "ServiceRequest/ec11f683-8779-4fcf-a9b7-1ce1b0033968",
"type": "ServiceRequest"
}
],
"id": "78a9b719-7087-4305-9fc6-c2c56c796e85",
"status": "final",
"category": [
{ //Represents more meta data about the observation - This is optional
"coding": [
{
"system": "https://mi-cie.org/fhir/StructureDefinition",
"code": "CODE_v2",
"display": "FRIENDLY CODE NAME"
}
]
}
],
"code": {
"coding": [
{ // THIS REPRESENTS WHAT THE OBSERVATION IS
"system": "https://mi-cie.org/fhir/StructureDefinition/clientSituation",
"code": "clientSituation_v2",
"display": "Client Situation"
}
]
},
"subject": {
"reference": "Patient/a41d9169-0dc9-4645-bc85-fbd3fafc4fee",
"display": "PUTFIRSTNAME PUTLASTNAME"
},
"valueString": "Test",
"effectiveDateTime": "2024-07-22T11:26:45-04:00"
}
}
]
} |
The following describes how to make this call POST / .