Client

A client is a healthcare system object that requests information and processing from an external service. This is typically an EHR system, but we may also support other health objects in the future such as a CPOE (Computerized Physician Order Entry).

We can mark a client by using the decorator @hc.ehr. You must declare a particular workflow for the EHR client, which informs the sandbox how your data will be formatted. You can find more information on the Use Cases documentation page.

Data returned from the client should be wrapped in a Prefetch object, where prefetch is a dictionary of FHIR resources with keys corresponding to the CDS service.

You can optionally specify the number of requests to generate with the num parameter.

Clinical DocumentationCDS

import healthchain as hc

from healthchain.use_cases import ClinicalDocumentation
from healthchain.fhir import create_document_reference

from fhir.resources.documentreference import DocumentReference

@hc.sandbox
class MyCoolSandbox(ClinicalDocumentation):
    def __init__(self) -> None:
        pass

    @hc.ehr(workflow="sign-note-inpatient", num=10)
    def load_data_in_client(self) -> DocumentReference:
        # Do things here to load in your data
        return create_document_reference(data="", content_type="text/xml")

import healthchain as hc

from healthchain.use_cases import ClinicalDecisionSupport
from healthchain.models import Prefetch

from fhir.resources.patient import Patient

@hc.sandbox
class MyCoolSandbox(ClinicalDecisionSupport):
    def __init__(self) -> None:
        pass

    @hc.ehr(workflow="patient-view", num=10)
    def load_data_in_client(self) -> Prefetch:
        # Do things here to load in your data
        return Prefetch(prefetch={"patient": Patient(id="123")})