Concepts
To integrate Blueprint into your application, it is helpful to understand some key concepts and terminology:
- Partner: An organization that is using the Blueprint platform and combining it with their applications to create a novel integrated experience. Represented by
partnerin the API. - Partner application ("your application"): An application that will be integrated with Blueprint. Often this is an electronic health records (EHR) system or similar application that is used by a clinician.
- Organization: An organization of clinicians, such as a group practice. Typically this would be a customer of the partner who is interested in using the partner application integrated with Blueprint. Clinician and patient data is separated by organization boundaries. Represented by
organizationin the API. - Clinic: A location or facility within an organization, for example if a practice has multiple offices. At least one clinic must exist within an organization; for practices that don't want to subdivide their clinicians and patients by location or facilty, there will be a one-to-one relationship between organization and clinic. Represented by
clinicin the API. - Clinician: The end user of the application that is integrated with Blueprint. Typically this will be a mental health professional such as a therapist or psychiatrist. Represented by
clinicianin the API. - Client ("patient"): The human being treated by the clinician and to whom the clinical artifacts that Blueprint generates apply. For most of this documentation "client" refers to a human being treated (i.e. a "patient"). When referring to a technical component of an integration, this documentation will use "API client". Represented by
clientin the API. - Internal ID: Identifiers in UUID format that are generated by Blueprint and used to identify entities such as clinicians and clients. These identifiers will be universally unique. These identifiers will be used as path segments in the API routes.
- External ID: Identifiers in string format that are generated by the partner application and can be associated with Blueprint entities such as clinicians and clients. These identifiers are optional but are expected to be unique with the scope of a clinical organization.
Updated 6 months ago
