BSeR: Bidirectional Services_eReferral
BSeR: Bidirectional Services_eReferral
This page is part of the Bidirectional Services eReferrals (BSeR) (v1.0.0: STU 1) based on FHIR R4. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
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.
The official URL for this profile is:
http://hl7.org/fhir/us/bser/StructureDefinition/BSeR-ReferralMessageHeader
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MessageHeader
This structure is derived from MessageHeader
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MessageHeader | 0..* | MessageHeader | ||
  event[x] | 1..1 | Coding | Fixed Value: As shown | |
   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 | |
 display | 1..1 | string | Representation defined by the system Fixed Value: REF/RRI - Patient referral | |
 destination | 1..1 | BackboneElement | ||
 receiver | 1..1 | Reference(BSeR Referral Recipient Practitioner Role) | ||
| sender | 1..1 | Reference(BSeR Referral Initiator Practitioner Role) | ||
| reason | S | 0..1 | CodeableConcept | |
| focus | 1..1 | Reference(BSeR Referral Task) | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | I | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems |
 id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | I | 0..* | Extension | Additional content defined by implementations |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| event[x] | ΣI | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: MessageEvent (example) Fixed Value: As shown |
| id | 0..0 | string | Unique id for inter-element referencing | |
| extension | 0..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..0 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: I12 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: REF/RRI - Patient referral | |
| userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |
| destination | ΣI | 1..1 | BackboneElement | Message destination application(s) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name | ΣI | 0..1 | string | Name of system |
| target | ΣI | 0..1 | Reference(Device) | Particular delivery destination within the destination |
| endpoint | ΣI | 1..1 | url | Actual destination address or id |
| receiver | ΣI | 1..1 | Reference(BSeR Referral Recipient Practitioner Role) | Intended "real-world" recipient for the data |
| sender | ΣI | 1..1 | Reference(BSeR Referral Initiator Practitioner Role) | Real world sender of the message |
| enterer | ΣI | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry |
| author | ΣI | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision |
| source | ΣI | 1..1 | BackboneElement | Message source application |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name | ΣI | 0..1 | string | Name of system |
| software | ΣI | 0..1 | string | Name of software running the system |
| version | ΣI | 0..1 | string | Version of software running |
| contact | ΣI | 0..1 | ContactPoint | Human contact for problems |
| endpoint | ΣI | 1..1 | url | Actual message source address or id |
| responsible | ΣI | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event |
| reason | SΣI | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example) |
| response | ΣI | 0..1 | BackboneElement | If this is a reply to prior message |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| identifier | ΣI | 1..1 | id | Id of original message |
| code | ΣI | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required) |
| details | ΣI | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors |
| focus | ΣI | 1..1 | Reference(BSeR Referral Task) | The actual content of the message |
| definition | ΣI | 0..1 | canonical(MessageDefinition) | Link to the definition for this message |
| Documentation for this format | ||||
This structure is derived from MessageHeader
Differential View
This structure is derived from MessageHeader
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | ||
| event[x] | 1..1 | Coding | Fixed Value: As shown | |
| 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 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: REF/RRI - Patient referral | |
| destination | 1..1 | BackboneElement | ||
| receiver | 1..1 | Reference(BSeR Referral Recipient Practitioner Role) | ||
| sender | 1..1 | Reference(BSeR Referral Initiator Practitioner Role) | ||
| reason | S | 0..1 | CodeableConcept | |
| focus | 1..1 | Reference(BSeR Referral Task) | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | I | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| event[x] | ΣI | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: MessageEvent (example) Fixed Value: As shown |
| id | 0..0 | string | Unique id for inter-element referencing | |
| extension | 0..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..0 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: I12 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: REF/RRI - Patient referral | |
| userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |
| destination | ΣI | 1..1 | BackboneElement | Message destination application(s) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name | ΣI | 0..1 | string | Name of system |
| target | ΣI | 0..1 | Reference(Device) | Particular delivery destination within the destination |
| endpoint | ΣI | 1..1 | url | Actual destination address or id |
| receiver | ΣI | 1..1 | Reference(BSeR Referral Recipient Practitioner Role) | Intended "real-world" recipient for the data |
| sender | ΣI | 1..1 | Reference(BSeR Referral Initiator Practitioner Role) | Real world sender of the message |
| enterer | ΣI | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry |
| author | ΣI | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision |
| source | ΣI | 1..1 | BackboneElement | Message source application |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name | ΣI | 0..1 | string | Name of system |
| software | ΣI | 0..1 | string | Name of software running the system |
| version | ΣI | 0..1 | string | Version of software running |
| contact | ΣI | 0..1 | ContactPoint | Human contact for problems |
| endpoint | ΣI | 1..1 | url | Actual message source address or id |
| responsible | ΣI | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event |
| reason | SΣI | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example) |
| response | ΣI | 0..1 | BackboneElement | If this is a reply to prior message |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| identifier | ΣI | 1..1 | id | Id of original message |
| code | ΣI | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required) |
| details | ΣI | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors |
| focus | ΣI | 1..1 | Reference(BSeR Referral Task) | The actual content of the message |
| definition | ΣI | 0..1 | canonical(MessageDefinition) | Link to the definition for this message |
| Documentation for this format | ||||
Other representations of profile: Schematron
| Path | Conformance | ValueSet / Code |
| MessageHeader.language | preferred | CommonLanguages Max Binding: AllLanguages |
| MessageHeader.event[x] | example | Fixed Value: I12("REF/RRI - Patient referral") |
| MessageHeader.reason | example | ExampleMessageReasonCodes |
| MessageHeader.response.code | required | ResponseType |
| Id | Path | Details | Requirements |
| dom-2 | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | MessageHeader | 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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | MessageHeader | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | MessageHeader.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MessageHeader.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MessageHeader.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MessageHeader.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MessageHeader.event[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.destination | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.destination.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MessageHeader.destination.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MessageHeader.destination.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MessageHeader.destination.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MessageHeader.destination.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.destination.target | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.destination.endpoint | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.destination.receiver | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.sender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.enterer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.author | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.source | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.source.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MessageHeader.source.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MessageHeader.source.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MessageHeader.source.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MessageHeader.source.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.source.software | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.source.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.source.contact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.source.endpoint | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.responsible | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.reason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.response | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.response.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MessageHeader.response.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MessageHeader.response.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MessageHeader.response.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MessageHeader.response.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.response.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.response.details | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.focus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.definition | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
IG © 2019+ HL7 International - Public Health Work Group. Package hl7.fhir.us.bser#1.0.0 based on FHIR 4.0.1. Generated 2020-03-02
Links: Table of Contents |
QA Report | Search
| Version History |
|
Propose a change