Bidirectional Services eReferral (BSeR)
2.0.0-ballot - STU2
Bidirectional Services eReferral (BSeR)
2.0.0-ballot - STU2
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
| Official URL: http://hl7.org/fhir/us/bser/StructureDefinition/BSeR-ReferralMessageHeader | Version: 2.0.0-ballot | |||
| Active as of 2025-01-09 | Computable Name: BSeRReferralMessageHeader | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.33.42.6 | ||||
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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MessageHeader |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
  event[x] |
Σ | 1..1 | Coding | REF/RRI - Patient referral Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
  system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0003 | |
 code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: I12 | |
| destination |
Σ | 1..1 | BackboneElement | Message destination application(s) ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| endpoint |
Σ | 1..1 | url | Actual destination address or id ele-1: All FHIR elements must have a @value or children |
 receiver |
Σ | 1..1 | Reference(US Core PractitionerRole Profile) | Intended "real-world" recipient for the data ele-1: All FHIR elements must have a @value or children |
| sender |
Σ | 1..1 | Reference(US Core PractitionerRole Profile) | Real world sender of the message ele-1: All FHIR elements must have a @value or children |
| source |
Σ | 1..1 | BackboneElement | Message source application ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| endpoint |
Σ | 1..1 | url | Actual message source address or id ele-1: All FHIR elements must have a @value or children |
| reason |
SΣ | 0..1 | CodeableConcept | Cause of event Binding: US Core Procedure Codes (extensible) ele-1: All FHIR elements must have a @value or children |
| focus |
Σ | 1..1 | Reference(BSeR Referral Task) | The actual content of the message ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| MessageHeader.event[x] | example | Pattern: I12http://hl7.org/fhir/ValueSet/message-eventsfrom the FHIR Standard | |
| MessageHeader.reason | extensible | USCoreProcedureCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code |
This structure is derived from MessageHeader
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader |
MessageHeader | |||
| event[x] |
1..1 | Coding | REF/RRI - Patient referral Required Pattern: At least the following | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0003 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: I12 | |
 destination |
1..1 | BackboneElement | Message destination application(s) | |
| receiver |
1..1 | Reference(US Core PractitionerRole Profile) | Intended "real-world" recipient for the data | |
| sender |
1..1 | Reference(US Core PractitionerRole Profile) | Real world sender of the message | |
| reason |
S | 0..1 | CodeableConcept | Cause of event Binding: US Core Procedure Codes (extensible) |
| focus |
1..1 | Reference(BSeR Referral Task) | The actual content of the message | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| MessageHeader.reason | extensible | USCoreProcedureCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MessageHeader |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| event[x] |
Σ | 1..1 | Coding | REF/RRI - Patient referral Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0003 | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: I12 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| destination |
Σ | 1..1 | BackboneElement | Message destination application(s) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 0..1 | string | Name of system | ||||
| target |
Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
| endpoint |
Σ | 1..1 | url | Actual destination address or id | ||||
| receiver |
Σ | 1..1 | Reference(US Core PractitionerRole Profile) | Intended "real-world" recipient for the data | ||||
| sender |
Σ | 1..1 | Reference(US Core PractitionerRole Profile) | Real world sender of the message | ||||
| enterer |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry | ||||
| author |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision | ||||
| source |
Σ | 1..1 | BackboneElement | Message source application | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 0..1 | string | Name of system | ||||
| software |
Σ | 0..1 | string | Name of software running the system | ||||
| version |
Σ | 0..1 | string | Version of software running | ||||
| contact |
Σ | 0..1 | ContactPoint | Human contact for problems | ||||
| endpoint |
Σ | 1..1 | url | Actual message source address or id | ||||
| responsible |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event | ||||
| reason |
SΣ | 0..1 | CodeableConcept | Cause of event Binding: US Core Procedure Codes (extensible) | ||||
| response |
Σ | 0..1 | BackboneElement | If this is a reply to prior message | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier |
Σ | 1..1 | id | Id of original message | ||||
| code |
Σ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. | ||||
| details |
Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | ||||
| focus |
Σ | 1..1 | Reference(BSeR Referral Task) | The actual content of the message | ||||
| definition |
Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| MessageHeader.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| MessageHeader.event[x] | example | Pattern: I12http://hl7.org/fhir/ValueSet/message-eventsfrom the FHIR Standard | ||||
| MessageHeader.reason | extensible | USCoreProcedureCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code | ||||
| MessageHeader.response.code | required | ResponseTypehttp://hl7.org/fhir/ValueSet/response-code|4.0.1from the FHIR Standard |
This structure is derived from MessageHeader
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| event[x] |
Σ | 1..1 | Coding | REF/RRI - Patient referral Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0003 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: I12 | |
| destination |
Σ | 1..1 | BackboneElement | Message destination application(s) ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| endpoint |
Σ | 1..1 | url | Actual destination address or id ele-1: All FHIR elements must have a @value or children |
| receiver |
Σ | 1..1 | Reference(US Core PractitionerRole Profile) | Intended "real-world" recipient for the data ele-1: All FHIR elements must have a @value or children |
| sender |
Σ | 1..1 | Reference(US Core PractitionerRole Profile) | Real world sender of the message ele-1: All FHIR elements must have a @value or children |
| source |
Σ | 1..1 | BackboneElement | Message source application ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| endpoint |
Σ | 1..1 | url | Actual message source address or id ele-1: All FHIR elements must have a @value or children |
| reason |
SΣ | 0..1 | CodeableConcept | Cause of event Binding: US Core Procedure Codes (extensible) ele-1: All FHIR elements must have a @value or children |
| focus |
Σ | 1..1 | Reference(BSeR Referral Task) | The actual content of the message ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| MessageHeader.event[x] | example | Pattern: I12http://hl7.org/fhir/ValueSet/message-eventsfrom the FHIR Standard | |
| MessageHeader.reason | extensible | USCoreProcedureCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code |
Differential View
This structure is derived from MessageHeader
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader |
MessageHeader | |||
| event[x] |
1..1 | Coding | REF/RRI - Patient referral Required Pattern: At least the following | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0003 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: I12 | |
| destination |
1..1 | BackboneElement | Message destination application(s) | |
| receiver |
1..1 | Reference(US Core PractitionerRole Profile) | Intended "real-world" recipient for the data | |
| sender |
1..1 | Reference(US Core PractitionerRole Profile) | Real world sender of the message | |
| reason |
S | 0..1 | CodeableConcept | Cause of event Binding: US Core Procedure Codes (extensible) |
| focus |
1..1 | Reference(BSeR Referral Task) | The actual content of the message | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| MessageHeader.reason | extensible | USCoreProcedureCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MessageHeader |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| event[x] |
Σ | 1..1 | Coding | REF/RRI - Patient referral Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0003 | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: I12 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| destination |
Σ | 1..1 | BackboneElement | Message destination application(s) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 0..1 | string | Name of system | ||||
| target |
Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
| endpoint |
Σ | 1..1 | url | Actual destination address or id | ||||
| receiver |
Σ | 1..1 | Reference(US Core PractitionerRole Profile) | Intended "real-world" recipient for the data | ||||
| sender |
Σ | 1..1 | Reference(US Core PractitionerRole Profile) | Real world sender of the message | ||||
| enterer |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry | ||||
| author |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision | ||||
| source |
Σ | 1..1 | BackboneElement | Message source application | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 0..1 | string | Name of system | ||||
| software |
Σ | 0..1 | string | Name of software running the system | ||||
| version |
Σ | 0..1 | string | Version of software running | ||||
| contact |
Σ | 0..1 | ContactPoint | Human contact for problems | ||||
| endpoint |
Σ | 1..1 | url | Actual message source address or id | ||||
| responsible |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event | ||||
| reason |
SΣ | 0..1 | CodeableConcept | Cause of event Binding: US Core Procedure Codes (extensible) | ||||
| response |
Σ | 0..1 | BackboneElement | If this is a reply to prior message | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier |
Σ | 1..1 | id | Id of original message | ||||
| code |
Σ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. | ||||
| details |
Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | ||||
| focus |
Σ | 1..1 | Reference(BSeR Referral Task) | The actual content of the message | ||||
| definition |
Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| MessageHeader.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| MessageHeader.event[x] | example | Pattern: I12http://hl7.org/fhir/ValueSet/message-eventsfrom the FHIR Standard | ||||
| MessageHeader.reason | extensible | USCoreProcedureCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code | ||||
| MessageHeader.response.code | required | ResponseTypehttp://hl7.org/fhir/ValueSet/response-code|4.0.1from the FHIR Standard |
This structure is derived from MessageHeader
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 Public Health Working Group. Package hl7.fhir.us.bser#2.0.0-ballot based on FHIR 4.0.1. Generated 2025-01-09
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change