Versions Compared

Key

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

...

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 your the referring organization.

https://build.fhir.org/servicerequest.html

Patient

Represents information on the person that has person demographic information to be referred by the partner organization.

https://build.fhir.org/patient-definitions.html

Observation

Represents a piece of relevant information that is associated with a Service Request. This could be answer responses to a questionnaire or a test resultscreening, or details associated with a specific need.

Step 1 - Submit a Patient

Step one is to register a new patient within the systemHub. 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 you the referring organization to share your their unique identifiers to the record in this way you will be able to do , enabling subsequent searches by using your the referring org’s unique identifier. The following describes that process. Sharing your Unique Identifiers

The following is a an example payload for a patient. This will return a an identifier for the CIE Hub that can be used in the next bundle call.

...

Step two is to give information about the service request. There will be two types of FHIR resources: the Service Request and the Observation. The following is a an example of the Bundle

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"
      }
    }
  ]
}

...