Bidirectional Services eReferral (BSeR)
2.0.0-ballot - STU2 United States of America flag

Bidirectional Services eReferral (BSeR), published by HL7 Public Health Working Group. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/bser/ and changes regularly. See the Directory of published versions

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Core Referral Architecture Profiles

Referral Service Request

This ServiceRequest profile represents a request for a referral.

Referral Task

This Task profile represents the state of a task containing a referral service request.

Workflow Management Profiles

BSeR Referral Message Header

The FHIR MessageHeader resource is defined as “the header for a message exchange that is either requesting or responding to an action”. In BSeR the message header is used to exchange the referral service request or the referral service request feedback.

BSeR Referral Task

This Task profile represents state of a task containing a BSeR referral service request.

Referral Service Request Profiles

BSeR Referral Message Bundle

This Bundle profile represents a BSeR Referral Message Bundle. It contains the BSeR Referral MessageHeader and is for use in the BSeR messaging paradigm.

BSeR Referral Request Composition

This Composition profile represents the clinical supporting information included in the referral request document.

BSeR Referral Request Document Bundle

This Bundle profile represents an BSeR Referral Request Document Bundle. It contains the BSeR Referral Request Composition.

BSeR Referral Service Request

This ServiceRequest profile represents a BSeR request for a referral.

Referral Service Request Feedback Profiles

BSeR Referral Feedback Composition

This Composition profile represents the clinical feedback included in the referral feedback document.

BSeR Referral Feedback Document Bundle

This Bundle profile represents an BSeR Referral Feedback Document Bundle. It contains the BSeR Referral Feedback Composition.

Supporting Information Profiles (Request and Feedback)

BSeR Bundle Batch Query Referral Supporting Information

This Bundle profile is of type batch, is used to contain queries to represent use case specific referral request and feedback supporting information, and allows for descriptive query information.

BSeR Referral Observation

This Observation profile represents a supporting information observation used in either the referral request or the referral feedback.

BSeR Telcom Communication Preferences

This Observation profile represents a the patient’s preference with regard to contact via telecommunication (phone/email) such as the best day to call, the best time to call, whether a message can be left.

BSeR Tobacco Use Cessation Feedback Medication

This Medication represents a tobacco cessation medication.

Other Profiles

BSeR Coverage

This Coverage profile represents identifiers and descriptors of an insurance plan underwriting some or all of the cost of the referral services provided.

BSeR Patient Consent

This Consent profile represents the consent status of the patient with regard to treatment authorization or protected health information sharing.

Batch Query Bundle Referral Request Examples

Examples of referral request batch query Bundles for each use case described in the BSeR IG. Each Bundle is a batch of queries for definition and/or retrieval of supporting information for a use case specific referral request.

Batch Query Bundle - Arthritis Request Supporting Information Queries

This Bundle is a batch of queries for definition and/or retrieval of supporting information for an arthritis referral request. Each entry is used to represent a RESTful API request.

Batch Query Bundle - Diabetes Prevention Request Supporting Information Queries

This Bundle is a batch of queries for definition and/or retrieval of supporting information for a diabetes prevention referral request. Each entry is used to represent a RESTful API request.

Batch Query Bundle - Early Childhood Nutrition Request Supporting Information Queries

This Bundle is a batch of queries for definition and/or retrieval of supporting information for an early childhood nutrition referral request. Each entry is used to represent a RESTful API request.

Batch Query Bundle - Hypertension Request Supporting Information Queries

This Bundle is a batch of queries for definition and/or retrieval of supporting information for a hypertension referral request. Each entry is used to represent a RESTful API request.

Batch Query Bundle - Obesity Request Supporting Information Queries

This Bundle is a batch of queries for definition and/or retrieval of supporting information for an obesity referral request. Each entry is used to represent a RESTful API request.

Batch Query Bundle - Tobacco Use Cessation Request Supporting Information Queries

This Bundle is a batch of queries for definition and/or retrieval of supporting information for a tobacco use cessation referral request. Each entry is used to represent a RESTful API request.

Batch Query Bundle Referral Feedback Examples

Examples of referral feedback batch query Bundles for each use case described in the BSeR IG. Each Bundle is a batch of queries for definition and/or retrieval of supporting information for use case specific referral feedback.

Batch Query Bundle - Arthritis Feedback

This Bundle is a batch of requests to the FHIR RESTful API for referral feedback supporting information for an arthritis referral. Each entry is used to represent a RESTful API request.

Batch Query Bundle - Diabetes Prevention Feedback

This Bundle is a batch of requests to the FHIR RESTful API for referral feedback supporting information for a diabetes prevention referral. Each entry is used to represent a RESTful API request.

Batch Query Bundle - Early Childhood Nutrition Feedback

This Bundle is a batch of requests to the FHIR RESTful API for referral feedback supporting information for a early childhood nutrition referral. Each entry is used to represent a RESTful API request.

Batch Query Bundle - Hypertension Feedback

This Bundle is a batch of requests to the FHIR RESTful API for referral feedback supporting information for a hypertension referral. Each entry is used to represent a RESTful API request.

Batch Query Bundle - Obesity Feedback

This Bundle is a batch of requests to the FHIR RESTful API for referral feedback supporting information for a obesity referral. Each entry is used to represent a RESTful API request.

Batch Query Bundle - Tobacco Use Cessation Feedback

This Bundle is a batch of requests to the FHIR RESTful API for referral feedback supporting information for a tobacco use cessation referral. Each entry is used to represent a RESTful API request.

Core Referral Architecture Examples

ServiceRequest - Eve Everywoman

Referral ServiceRequest: Eve Everywoman example

Task - Eve Everywoman

Referral Task: Eve Everywoman example

Workflow Management Examples

MessageHeader - Patient Referral - Saint Lukes

BSeR Referral MessageHeader: Patient Referral - Saint Lukes example

Task - Arthritis Referral - Eve Everywoman

BSeR Referral Task: Eve Everywoman example

Referral Service Request Examples

Document Bundle - Baby Everybaby - Early Childhood Nutrition

BSeR Referral Request Document Bundle: Baby Everybaby - Early Childhood Nutrition

Document Bundle - Eve Everywoman - Arthritis

BSeR Referral Request Document Bundle: Eve Everywoman Arthritis example

Message Bundle - Eve Everywoman

BSeR Referral Message Bundle: Eve Everywoman example

ServiceRequest - Arthritis Referral - Eve Everywoman

BSeR Referral ServiceRequest: Arthritis Referral - Eve Everywoman example

ServiceRequest - Early Childhood Nutrition Referral - Baby Everybaby

BSeR Referral ServiceRequest: Early Childhood Nutrition Referral - Baby Everybaby example

Referral Service Request Examples: Composition

Composition - Baby Everybaby - Early Childhood Nutrition Referral Request

BSeR Referral Request Composition: Baby Everybaby - Early Childhood Nutrition example

Composition - Eve Everywoman - Arthritis Referral Request

BSeR Referral Request Composition: Eve Everywoman - Arthritis example

Composition - Eve Everywoman - Diabetes Prevention Referral Request

BSeR Referral Request Composition: Eve Everywoman - Diabetes Prevention example

Composition - Eve Everywoman - Hypertension Referral Request

BSeR Referral Request Composition: Eve Everywoman - Hypertension example

Composition - Eve Everywoman - Obesity Referral Request

BSeR Referral Request Composition: Eve Everywoman - Obesity example

Composition - Eve Everywoman - Tobacco Use Cessation Referral Request

BSeR Referral Request Composition: Eve Everywoman - Tobacco Use Cessation example

Referral Service Request Feedback Examples

Document Bundle - Eve Everywoman

BSeR Referral Feedback Document Bundle: Eve Everywoman example

Referral Service Request Feedback Examples: Composition

Composition - Baby Everybaby - Early Childhood Nutrition Referral Feedback

BSeR Referral Feedback Composition: Baby Everybaby - Early Childhood Nutrition example

Composition - Eve Everywoman - Arthritis Referral Feedback

BSeR Referral Feedback Composition: Eve Everywoman - Arthritis example

Supporting Information Examples

AllergyIntolerance - Sulfonamide - Eve Everywoman

US Core AllergyIntolerance: Sulfonamide - Eve Everywoman example

Blood Pressure - Baby Everybaby

US Core Blood Pressure: Baby Everybaby example

Blood Pressure - Mom Everymom

US Core Blood Pressure: Mom Everymom example

BMI - Mom Everymom

US Core BMI: Mom Everymom example

Body Height - Mom Everymom

US Core Body Height: Mom Everymom example

Body Weight - Baby Everybaby

US Core Body Weight: Baby Everybaby example

Body Weight - Eve Everywoman

US Core Body Weight: Eve Everywoman example

Body Weight - Mom Everymom

US Core Body Weight: Mom Everymom example

Condition - Hypertension - Eve Everywoman

US Core Condition Problems Health Concerns: Hypertension - Eve Everywoman example

Observation - Best Day to Call - Eve Everywoman

BSeR Telcom Comm Observation: Best Day to Call - Eve Everywoman example

Observation - Blood Pressure - Eve Everywoman

US Core Blood Pressure: Blood Pressure - Eve Everywoman example

Observation - BMI - Eve Everywoman

US Core BMI: Eve Everywoman example

Observation - Body Height - Baby Everybaby

US Core Body Height: Baby Everybaby example

Observation - Body Height - Eve Everywoman

US Core Body Height: Eve Everywoman example

Observation - Eve Everywoman - Employed

ODH Employment Status: Eve Everywoman - Employed example

Observation - Feedback - Decreased lactation - Baby Everybaby

BSeR Referral Observation: Feedback - Decreased lactation - Baby Everybaby example

Observation - Ha1c - Eve Everywoman

US Core Laboratory Result Observation: Ha1c - Eve Everywoman example

Observation - Latch to Breast - Baby Everybaby

BSeR Early Childhood Nutrition Observation: Latch to Breast - Baby Everybaby example

Observation - Mom Everymom - Employed

ODH Employment Status: Mom Everymom - Employed example

Observation - Painful lactation - Baby Everybaby

BSeR Early Childhood Nutrition Feedback Observation: Painful lactation - Baby Everybaby example

Procedure - Nicotine replacement therapy - Eve Everywoman

US Core Procedure: Nicotine replacement therapy - Eve Everywoman example

Smoking Status - Eve Everywoman

US Core Smoking Status: Eve Everywoman example

Supporting Information Feedback Examples

BSeR Referral Observation - Arthritis Feedback - Endurance Improved - Eve Everywoman

BSeR Referral Observation: Arthritis Feedback - Endurance Improved - Eve Everywoman example

Medication - bupropion - Eve Everywoman

Medication: bupropion - Eve Everywoman example

MedicationRequest - Amoxicillin - Eve Everywoman

US Core MedicationRequest: Amoxicillin - Eve Everywoman example

Observation - Appointments Attended - Eve Everywoman

US Core Observation Social History: Referral Feedback - Appointments Attended - Eve Everywoman example

Observation - Appointments Missed - Eve Everywoman

US Core Observation Social History: Referral Feedback - Appointments Missed - Eve Everywoman example

Observation - Date for cessation of smoking - Eve Everywoman

US Core Observation Social History: Referral Feedback - Date for cessation of smoking - Eve Everywoman example

Observation - Pain Management - Eve Everywoman

BSeR Arthritis Feedback Observation: Pain Management - Eve Everywoman example

Observation - Tobacco free duration - Eve Everywoman

US Core Observation Social History: Referral Feedback - Tobacco free duration - Eve Everywoman example

Referral Participant Examples

Location - Referral Center A, St. Lukes

US Core Location: Referral Center A, St. Lukes example

Organization - Acme Lab

US Core Organization: Acme Lab example

Organization - Saint Luke's Hospital of Kansas City

US Core Organization: Saint Luke’s Hospital of Kansas City example

Patient - Baby Everybaby

US Core Patient: Baby Everybaby example

Patient - Eve Everywoman

US Core Patient: Eve Everywoman example

Patient - Mom Everymom

US Core Patient: Mom Everymom example

PracitionerRole - Referral Initiator - Primary Care Clinis St. Luke

US Core PracitionerRole: Referral Initiator - Primary Care Clinis St. Luke example

Practitioner - Hailey Eight

US Core Practitioner: Hailey Eight example

Practitioner - Henry Seven

US Core Practitioner: Henry Seven example

PractitionerRole - Referral Recipient - Hailey Eight

US Core PractitionerRole: Referral Recipient: Hailey Eight example

RelatedPerson - Gestational Mother - Eve Everywoman

US Core RelatedPerson: Gestational Mother - Eve Everywoman example

RelatedPerson - Gestational Mother - Mom Everymom

US Core RelatedPerson: Gestational Mother - Mom Everymom example

Other Examples

Consent - Baby Everybaby

BSeR Patient Consent: Baby Everybaby example

Consent - Eve Everywoman

BSeR Patient Consent: Eve Everywoman example

Coverage - Baby Everybaby

BSeR Coverage: Baby Everybaby example

Coverage - Eve Everywoman

BSeR Coverage: Eve Everywoman example

Observation - Education Level - Eve Everywoman

US Core Observation Social History: Education Level - Eve Everywoman example

Observation - Education Level - Mom Everymom

US Core Observation Social History: Education Level - Mom Everymom example

Code Systems

BSeR

BSeR code system

Task Business Status Code System

BSeR Task Business Status code system

Value Sets

BSeR Telcom Communication Preferences VS

BSeR Telcom Communication Preferences value set

Task Business Status VS

BSeR Task Business Status value set

Capability Statement

Capability Statement -BSeR

Capability Statement: BSeR - defines the expected capabilities for both client and server participating in BSeR exchange

Other

Parameters - US SNOMED

Parameters - US SNOMED

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

QueryDescription

This extension allows for descriptive information associated with a specific query in the batch.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

RelatedPerson - Self - Eve Everywoman

US Core RelatedPerson: Self - Eve Everywoman example