BSeR: Bidirectional Services_eReferral
1.0.0 - CI Build

BSeR: Bidirectional Services_eReferral, published by HL7 International - Public Health Work Group. This is not an authorized publication; it is the continuous build for version 1.0.0). 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.

Referral Participant Resources

BSeR_Organization An organization resource playing the roles of practitioner affiliated organization, patient coverage payer organization, or patient employer organization.
BSeR_Practitioner An individual who are engaged in the health care process or health care-related services as part of their formal responsibilities.
BSeR_ReferralInitiatorPractitionerRole The FHIR R4 PractitionerRole resource covers the recording of the location and types of services that Practitioners are able to provide for an organization. This profile for the PractitionerRole resource represents the practitioner in the role of referral initiator.
BSeR_ReferralRecipientPractitionerRole The FHIR R4 PractitionerRole resource covers the recording of the location and types of services that Practitioners are able to provide for an organization. This profile for the PractitionerRole resource represents the practitioner in the role of referral recipient.
BSeR_ServiceDeliveryLocation Service delivery location is physical place used by a referral initiating practitioner or referral recipient practitioner as the location to deliver services.

Workflow Management Resources

BSeR_ReferralMessageHeader 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 services request or the referral service request feedback.
BSeR_ReferralTask A task resource describes an activity that can be performed and tracks the state of completion of that activity. It is used in BSeR to track the performance and state of completion of the referral service request.

Referral Service Request Resources

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_ReferralRequestComposition The structural body and metadata of the referral request document.
BSeR_ReferralRequestDocumentBundle This Bundle profile represents an BSeR Referral Request Document Bundle. It contains the BSeR Referral Request Composition.
BSeR_ReferralServiceRequest The referral service request is a profile of the FHIR ServiceRequest resource, a record of a request for service such as diagnostic investigations, treatments, or operations to be performed.

Referral Service Request Feedback Resources

BSeR_ReferralActivityStatus An observation made by the referral recipient regarding the state of the referral service request. This observation is included as part of the referral feedback as a further elaboration of the business state in task.
BSeR_ReferralFeedbackComposition The structural body and metadata of the referral feedback document.
BSeR_ReferralFeedbackDocumentBundle This Bundle profile represents an BSeR Referral Feedback Document Bundle. It contains the BSeR Referral Feedback Composition.

Service Request and Referral Feedback Supporting Information Bundles

BSeR_ArthritisReferralFeedbackSupportingInformation A bundle of clinical statements providing supporting information for a referral recipients feedback on a arthritis referral.
BSeR_ArthritisReferralSupportingInformation A bundle of clinical statements authored by the referral initiator as supporting information for a arthritis related service request referral.
BSeR_EarlyChildhoodNutritionReferralFeedbackSupportingInformation A bundle of clinical statements providing supporting information for a referral recipient's feedback on an early childhood nutrition referral.
BSeR_DiabetesPreventionReferralFeedbackSupportingInformation A bundle of clinical statements authored by the referral recipient as supporting information for feedback provided to a referral initiator.
BSeR_DiabetesPreventionReferralSupportingInformation A bundle of clinical statements authored by the referral initiator as supporting information for a diabetes prevention related referral.
BSeR_EarlyChildhoodNutritionReferralSupportingInformation A bundle of clinical statements authored by the referral initiator as supporting information for early childhood nutrition referral.
BSeR_HypertensionReferralFeedbackSupportingInformation A bundle of clinical statements authored by the referral recipient as supporting information for feedback provided to a referral initiator regarding a hypertension referral.
BSeR_HypertensionReferralSupportingInformation A bundle of clinical statements authored by the referral initiator as supporting information for a hypertension referral.
BSeR_ObesityReferralFeedbackSupportingInformation A bundle of clinical statements authored by the referral recipient as supporting information for feedback provided to a referral initiator regarding a obesity referral.
BSeR_ObesityReferralSupportingInformation A bundle of clinical statements authored by the referral initiator as supporting information for an obesity referral.
BSeR_TobaccoUseCessationReferralFeedbackSupportingInformation A bundle of clinical statements providing supporting information for a referral recipients feedback on a tobacco use cessation referral.
BSeR_TobaccoUseCessationReferralSupportingInformation A bundle of clinical statements authored by the referral initiator as supporting information for a tobacco use cessation service request referral.

Supporting Information Resources

BSeR_ArthritisFeedbackObservation A collection of observational data points concerning the patient arthritic condition provided by the referral recipient as feedback to the referral initiator.
BSeR_Diagnosis A health condition of the referral patient.
BSeR_EarlyChildhoodNutritionFeedbackObservation A collection of observational data points authored by the referral recipient providing feedback to the referral initiator concerning an early childhood nutrition referral.
BSeR_EarlyChildhoodNutritionObservation A collection of observational data points authored by the referral initiator as part of supporting information related to an early childhood nutrition referral.
BSeR_HA1C-Observation A measure of the amount or percentage of hemoglobin A1c in the patient's blood. This observation is used a supporting information primarily for diabetes prevention referrals.
BSeR_MedicationStatement A statement of a patient medication history used as supporting information for a patient service request referral.
BSeR_NRT-AuthorizationStatus An observation regarding the status (approved, denied, pending) of an authorization for the patient to participate in Nicotine Replacement Therapy.
BSeR_ParticipationFeedbackObservation An observation regarding the level of participation in the services provided by the referral recipient, such as the number of sessions attended.
BSeR-TelcomCommunicationPreferences A collection of observations about the patient's preferences with regard to contact via telecommunication (phone/email) such as best Day To Call, best Time To Call, and leave Message Indicator.
BSeR_TobaccoUseCessationFeedbackMedication A statement regarding the use of a tobacco cessation medication. Medication.status indicates active or inactive use of the medication indicated in medication.code.
BSeR_TobaccoUseCessationFeedbackObservation A collection of observational data points provided by the referral recipient as feedback to the referral initiator. Tobacco use cessation feedback observations include quit Date, session type, and tobacco free duration.

Other Resources

BSeR_Coverage Coverage high-level identifiers and descriptors of an insurance plan underwriting some or all of the cost of the referral services provided.
BSeR_EducationLevel The highest level of education achieved by the patient. This is an optional demographic element of the patient included in all referral types.
BSeR_PatientConsent A record regarding the consent status of the patient with regard to treatment authorization or protected health information sharing.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems complying with the implementation guide are expected to declare conformance to one or more of the following capability statements.

Capability Statement BSeR This resource defines the expected capabilities for both client and server participating in BSeR exchange

Terminology: Value Sets

These define sets of codes used by systems conforming with this implementation guide

BSeR Telcom Communication Preferences VS BSeR Telcom Communication Preferences value set
Task Business Status VS BSeR Task Business Status value set

Terminology: Code Systems

These define new code systems used by systems conforming with this implementation guide

BSeR BSeR code system
Task Business Status Code System BSeR Task Business Status code system

Example: Example Instances

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

bundle-bser-arthritis-referral-everywoman Example of BSeR-ArthritisReferralSupportingInformation profile as used in the BSeR IG
bundle-bser-arthritis-referral-feedback-eve-everywoman Example of BSeR-ArthritisReferralFeedbackSupportingInformation profile as used in the BSeR IG
bundle-bser-diabetes-referral-eve-everywoman Example of BSeR-DiabetesPreventionReferralSupportingInformation profile as used in the BSeR IG
bundle-bser-diabetes-referral-feedback-eve-everywoman Example of BSeR-DiabetesPreventionReferralFeedbackSupportingInformation profile as used in the BSeR IG
bundle-bser-hypertensions-feedback-eve-everywoman Example of BSeR-HypertensionReferralFeedbackSupportingInformation profile as used in the BSeR IG
bundle-bser-hypertensions-referral-eve-everywoman Example of BSeR-HypertensionReferralSupportingInformation profile as used in the BSeR IG
bundle-bser-nutrition-referral-eve-everywoman Example of BSeR-EarlyChildhoodNutritionReferralSupportingInformation profile as used in the BSeR IG
bundle-bser-nutrition-referral-feedback-eve-everywoman Example of BSeR-ChildhoodNutritionReferralFeedbackSupportingInformation profile as used in the BSeR IG
bundle-bser-obesity-feedback-eve-everywoman Example of BSeR-ObesityReferralFeedbackSupportingInformation profile as used in the BSeR IG
bundle-bser-obesity-referral-eve-everywoman Example of BSeR-ObesityReferralSupportingInformation profile as used in the BSeR IG
bundle-bser-referral-feedback-document-bundle-eve-everywoman Example of BSeR-ReferralFeedbackDocumentBundle profile as used in the BSeR IG
bundle-bser-referral-message-bundle-eve-everywoman Example of BSeR-ReferralMessageBundle profile as used in the BSeR IG
bundle-bser-referral-request-document-bundle-eve-everywoman Example of BSeR-ReferralRequestDocumentBundle profile as used in the BSeR IG
bundle-bser-tobacco-referral-eve-everywoman Example of BSeR-TobaccoUseCessationReferralSupportingInformation profile as used in the BSeR IG
bundle-bser-tobacco-referral-feedback-eve-everywoman Example of BSeR-TobaccoUseCessationReferralFeedbackSupportingInformation profile as used in the BSeR IG
Referral feedback Example of StructureDefinition/BSeR-ReferralFeedbackComposition profile as used in the BSeR IG
Referral request Example of BSeR-ReferralRequestComposition profile as used in the BSeR IG
allergyintolerance-us-core-allergyint-eve-everywoman Example of US Core AllergyIntolerance profile as used in the BSeR IG
condition-BSeR-Diagnosis-eve-everywoman-diabetes Example of BSeR-Diagnosis profile as used in the BSeR IG
consent-BSeR-PatientConsent-eve-everywoman Example of BSeR-PatientConsent profile as used in the BSeR IG
coverage-BSeR-Coverage-eve-everywoman Example of BSeR-Coverage profile as used in the BSeR IG
Referral Center A, St. Lukes Example of BSeR-ServiceDeliveryLocation profile as used in the BSeR IG
medication-bser-tobacco-use-cessation-feedback-eve-everywoman Example of BSeR-TobaccoUseCessationFeedbackMedication profile as used in the BSeR IG
medicationstatement-BSeR-eve-everywoman Example of BSeR-MedicationStatement profile as used in the BSeR IG
messageheader-BSeR-ReferralMessageHeader Example of BSeR-ReferralMessageHeader profile as used in the BSeR IG
observation-blood-pressure-eve-everywoman Example of FHIR Blood Pressure profile as used in the BSeR IG
observation-bmi-eve-everywoman Example of FHIR BMI profile as used in the BSeR IG
observation-body-height-baby-everybaby Example of FHIR Vital Sign Observation as used in the BSeR IG
observation-body-height-eve-everywoman Example of FHIR Body Height profile as used in the BSeR IG
observation-body-weight-eve-everywoman Example of FHIR Body Weight profile as used in the BSeR IG
observation-BSeR-ArthritisFeedbackObservation-1-eve-everywoman Example of BSeR-ArthritisFeedbackObservation profile as used in the BSeR IG
observation-BSeR-ArthritisFeedbackObservation-2-eve-everywoman Example of BSeR-ArthritisFeedbackObservation profile as used in the BSeR IG
observation-BSeR-EducationLevel-eve-everywoman Example of BSeR-EducationLevel profile as used in the BSeR IG
observation-BSeR-HA1c-Observation-eve-everywoman Example of BSeR-HA1C-Observation profile as used in the BSeR IG
observation-BSeR-NRT-AuthorizationStatus-eve-everywoman Example of BSeR-NRT-AuthorizationStatus profile as used in the BSeR IG
observation-BSeR-NutritionFeedbackObs-1-eve-everywoman Example of BSeR-EarlyChildhoodNutritionFeedbackObservation profile as used in the BSeR IG
observation-BSeR-NutritionFeedbackObs-2-eve-everywoman Example of BSeR-EarlyChildhoodNutritionFeedbackObservation profile as used in the BSeR IG
observation-BSeR-NutritionObs-eve-everywoman Example of BSeR-EarlyChildhoodNutritionObservation profile as used in the BSeR IG
observation-BSeR-ReferralActivityStatus-eve-everywoman Example of BSeR-ReferralActivityStatus profile as used in the BSeR IG
observation-BSeR-TelcomComm-eve-everywoman Example of BSeR-TelcomCommunicationPreferences profile as used in the BSeR IG
observation-BSeR-TobaccoUseCessationFeedbackObs-1-eve-everywoman Example of BSeR-TobaccoUseCessationFeedbackObservation profile as used in the BSeR IG
observation-BSeR-TobaccoUseCessationFeedbackObs-2-eve-everywoman Example of BSeR-TobaccoUseCessationFeedbackObservation profile as used in the BSeR IG
observation-odh-employment-status-eve-everywoman Example of ODH Employment Status profile as used in the BSeR IG
observation-ParticipationFeedbackObservation-1-eve-everywoman Example of BSeR-ParticipationFeedbackObservation profile as used in the BSeR IG
observation-ParticipationFeedbackObservation-2-eve-everywoman Example of BSeR-ParticipationFeedbackObservation profile as used in the BSeR IG
observation-us-core-smokingstatus-eve-everywoman Example of US Core Smoking Status profile as used in the BSeR IG
Acme Labs Example of BSeR-Organization profile as used in the BSeR IG
Saint Luke's Hospital of Kansas City Example of BSeR-Organization profile as used in the BSeR IG
Patient Baby B Everybaby Example of US Core Patient profile as used in the BSeR IG
Patient Eve L Everywoman Example of US Core Patient profile as used in the BSeR IG
Patient Mom L Everymom Example of US Core Patient profile as used in the BSeR IG
Practitioner Eight Hailey Example of BSeR-Practitioner profile as used in the BSeR IG
Practitioner Seven Henry Example of BSeR-Practitioner profile as used in the BSeR IG
practitionerrole-bser-referral-initiator Example of BSeR-ReferralInitiatorPractitionerRole profile as used in the BSeR IG
practitionerrole-bser-referral-recipient Example of BSeR-ReferralRecipientPractitionerRole profile as used in the BSeR IG
RelatedPerson Mom L Everymom Example of FHIR RelatedPerson resource as used in the BSeR IG
RelatedPerson Self Eve Everywoman Example of FHIR RelatedPerson resource as used in the BSeR IG
servicerequest-BSeR-ReferralServiceRequest Example of BSeR-ReferralServiceRequest profile as used in the BSeR IG
task-BSeR-ReferralTask Example of BSeR-ReferralTask profile as used in the BSeR IG