0.1.0 - ci-build

eReferralMustSupport - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: CAeReCMessageHeader

Official URL: http://hl7.ca/fhir/eReferral/StructureDefinition/CAeReCMessageHeader | Version: 0.1.0
Draft as of 2024-08-15 | Computable Name: CAeReCMessageHeader

The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.

Usage:

- Use this Resource Profile: CAeReCBundle

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from MessageHeader

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
MessageHeader |  |  | MessageHeader |
id | S | 1..1 | id | Logical id of this artifact
event[x] | S | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: Message Event Code (extensible)
destination | S | 0..* | BackboneElement | Message destination application(s)
endpoint | S | 1..1 | url | Actual destination address or id
receiver | S | 0..1 | Reference(CAeReCPractitioner | CAeReCPractitionerRole | CAeReCOrganization) | Intended "real-world" recipient for the data
reference | S | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S | 0..1 | Identifier | Logical reference, when literal reference is not known
system | S | 1..1 | uri | The namespace for the identifier value
value | S | 1..1 | string | The value that is unique
sender |  | 0..1 | Reference(CAeReCPractitioner | CAeReCPractitionerRole | CAeReCOrganization) | Real world sender of the message
reference | S | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S | 0..1 | Identifier | Logical reference, when literal reference is not known
system | S | 1..1 | uri | The namespace for the identifier value
value | S | 1..1 | string | The value that is unique
enterer |  | 0..1 | Reference(CAeReCPractitionerRole | CAeReCPractitioner) | The source of the data entry
reference | S | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S | 0..1 | Identifier | Logical reference, when literal reference is not known
system | S | 1..1 | uri | The namespace for the identifier value
value | S | 1..1 | string | The value that is unique
author | S | 1..1 | Reference(CAeReCPractitionerRole) | The source of the decision
reference | S | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S | 0..1 | Identifier | Logical reference, when literal reference is not known
system | S | 1..1 | uri | The namespace for the identifier value
value | S | 1..1 | string | The value that is unique
source | S | 1..1 | BackboneElement | Message source application
endpoint | S | 1..1 | url | Actual message source address or id
reason | S | 0..1 | CodeableConcept | Cause of event
response |  |  |  |
identifier | S | 1..1 | id | Id of original message
code | S | 1..1 | code | ok | transient-error | fatal-error
details | S | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors
focus | S | 1..* | Reference(CAeReCServiceRequest | CAeReCTask | CAeReCAppointment | CAeReCCommunication) | The actual content of the message
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
MessageHeader.event[x] | extensible | MessageEventCode `http://hl7.ca/fhir/eReferral/ValueSet/message-event-code` from this IG

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
MessageHeader |  | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems
id | S Σ | 1..1 | id | Logical id of this artifact
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
event[x] | S Σ | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: Message Event Code (extensible)
destination | S Σ | 0..* | BackboneElement | Message destination application(s)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
endpoint | S Σ | 1..1 | url | Actual destination address or id
receiver | S Σ | 0..1 | Reference(CAeReCPractitioner | CAeReCPractitionerRole | CAeReCOrganization) | Intended "real-world" recipient for the data
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
sender | Σ | 0..1 | Reference(CAeReCPractitioner | CAeReCPractitionerRole | CAeReCOrganization) | Real world sender of the message
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
enterer | Σ | 0..1 | Reference(CAeReCPractitionerRole | CAeReCPractitioner) | The source of the data entry
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
author | S Σ | 1..1 | Reference(CAeReCPractitionerRole) | The source of the decision
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
source | S Σ | 1..1 | BackboneElement | Message source application
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
endpoint | S Σ | 1..1 | url | Actual message source address or id
reason | S Σ | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.
response | Σ | 0..1 | BackboneElement | If this is a reply to prior message
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
identifier | S Σ | 1..1 | id | Id of original message
code | S Σ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message.
details | S Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors
focus | S Σ | 1..* | Reference(CAeReCServiceRequest | CAeReCTask | CAeReCAppointment | CAeReCCommunication) | The actual content of the message
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
MessageHeader.event[x] | extensible | MessageEventCode `http://hl7.ca/fhir/eReferral/ValueSet/message-event-code` from this IG
MessageHeader.destination.receiver.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
MessageHeader.sender.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
MessageHeader.enterer.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
MessageHeader.author.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
MessageHeader.reason | example | ExampleMessageReasonCodes `http://hl7.org/fhir/ValueSet/message-reason-encounter` from the FHIR Standard
MessageHeader.response.code | required | ResponseType `http://hl7.org/fhir/ValueSet/response-code|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | 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 | error | 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 | error | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | MessageHeader | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
MessageHeader |  | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems
id | S Σ | 1..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.
Additional Bindings | Purpose
AllLanguages | Max Binding
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] | S Σ | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: Message Event Code (extensible)
destination | S Σ | 0..* | 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 | S Σ | 1..1 | url | Actual destination address or id
receiver | S Σ | 0..1 | Reference(CAeReCPractitioner | CAeReCPractitionerRole | CAeReCOrganization) | Intended "real-world" recipient for the data
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
display | Σ | 0..1 | string | Text alternative for the resource
sender | Σ | 0..1 | Reference(CAeReCPractitioner | CAeReCPractitionerRole | CAeReCOrganization) | Real world sender of the message
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
display | Σ | 0..1 | string | Text alternative for the resource
enterer | Σ | 0..1 | Reference(CAeReCPractitionerRole | CAeReCPractitioner) | The source of the data entry
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
display | Σ | 0..1 | string | Text alternative for the resource
author | S Σ | 1..1 | Reference(CAeReCPractitionerRole) | The source of the decision
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
display | Σ | 0..1 | string | Text alternative for the resource
source | S Σ | 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 | S Σ | 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: ExampleMessageReasonCodes (example): Reason for event occurrence.
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 | S Σ | 1..1 | id | Id of original message
code | S Σ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message.
details | S Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors
focus | S Σ | 1..* | Reference(CAeReCServiceRequest | CAeReCTask | CAeReCAppointment | CAeReCCommunication) | The actual content of the message
definition | Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
MessageHeader.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
MessageHeader.event[x] | extensible | MessageEventCode `http://hl7.ca/fhir/eReferral/ValueSet/message-event-code` from this IG
MessageHeader.destination.receiver.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
MessageHeader.destination.receiver.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
MessageHeader.destination.receiver.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
MessageHeader.sender.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
MessageHeader.sender.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
MessageHeader.sender.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
MessageHeader.enterer.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
MessageHeader.enterer.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
MessageHeader.enterer.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
MessageHeader.author.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
MessageHeader.author.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
MessageHeader.author.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
MessageHeader.reason | example | ExampleMessageReasonCodes `http://hl7.org/fhir/ValueSet/message-reason-encounter` from the FHIR Standard
MessageHeader.response.code | required | ResponseType `http://hl7.org/fhir/ValueSet/response-code|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | 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 | error | 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 | error | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | MessageHeader | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

This structure is derived from MessageHeader

Summary

Mandatory: 3 elements(8 nested mandatory elements)
Must-Support: 29 elements

Structures

This structure refers to these other structures:

- CAeReCPractitioner (http://hl7.ca/fhir/eReferral/StructureDefinition/CAeReCPractitioner)
- CAeReCPractitionerRole (http://hl7.ca/fhir/eReferral/StructureDefinition/CAeReCPractitionerRole)
- CAeReCOrganization (http://hl7.ca/fhir/eReferral/StructureDefinition/CAeReCOrganization)
- CAeReCServiceRequest (http://hl7.ca/fhir/eReferral/StructureDefinition/CAeReCServiceRequest)
- CAeReCTask (http://hl7.ca/fhir/eReferral/StructureDefinition/CAeReCTask)
- CAeReCAppointment (http://hl7.ca/fhir/eReferral/StructureDefinition/CAeReCAppointment)
- CAeReCCommunication (http://hl7.ca/fhir/eReferral/StructureDefinition/CAeReCCommunication)

Differential View

This structure is derived from MessageHeader

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
MessageHeader |  |  | MessageHeader |
id | S | 1..1 | id | Logical id of this artifact
event[x] | S | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: Message Event Code (extensible)
destination | S | 0..* | BackboneElement | Message destination application(s)
endpoint | S | 1..1 | url | Actual destination address or id
receiver | S | 0..1 | Reference(CAeReCPractitioner | CAeReCPractitionerRole | CAeReCOrganization) | Intended "real-world" recipient for the data
reference | S | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S | 0..1 | Identifier | Logical reference, when literal reference is not known
system | S | 1..1 | uri | The namespace for the identifier value
value | S | 1..1 | string | The value that is unique
sender |  | 0..1 | Reference(CAeReCPractitioner | CAeReCPractitionerRole | CAeReCOrganization) | Real world sender of the message
reference | S | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S | 0..1 | Identifier | Logical reference, when literal reference is not known
system | S | 1..1 | uri | The namespace for the identifier value
value | S | 1..1 | string | The value that is unique
enterer |  | 0..1 | Reference(CAeReCPractitionerRole | CAeReCPractitioner) | The source of the data entry
reference | S | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S | 0..1 | Identifier | Logical reference, when literal reference is not known
system | S | 1..1 | uri | The namespace for the identifier value
value | S | 1..1 | string | The value that is unique
author | S | 1..1 | Reference(CAeReCPractitionerRole) | The source of the decision
reference | S | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S | 0..1 | Identifier | Logical reference, when literal reference is not known
system | S | 1..1 | uri | The namespace for the identifier value
value | S | 1..1 | string | The value that is unique
source | S | 1..1 | BackboneElement | Message source application
endpoint | S | 1..1 | url | Actual message source address or id
reason | S | 0..1 | CodeableConcept | Cause of event
response |  |  |  |
identifier | S | 1..1 | id | Id of original message
code | S | 1..1 | code | ok | transient-error | fatal-error
details | S | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors
focus | S | 1..* | Reference(CAeReCServiceRequest | CAeReCTask | CAeReCAppointment | CAeReCCommunication) | The actual content of the message
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
MessageHeader.event[x] | extensible | MessageEventCode `http://hl7.ca/fhir/eReferral/ValueSet/message-event-code` from this IG

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
MessageHeader |  | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems
id | S Σ | 1..1 | id | Logical id of this artifact
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
event[x] | S Σ | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: Message Event Code (extensible)
destination | S Σ | 0..* | BackboneElement | Message destination application(s)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
endpoint | S Σ | 1..1 | url | Actual destination address or id
receiver | S Σ | 0..1 | Reference(CAeReCPractitioner | CAeReCPractitionerRole | CAeReCOrganization) | Intended "real-world" recipient for the data
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
sender | Σ | 0..1 | Reference(CAeReCPractitioner | CAeReCPractitionerRole | CAeReCOrganization) | Real world sender of the message
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
enterer | Σ | 0..1 | Reference(CAeReCPractitionerRole | CAeReCPractitioner) | The source of the data entry
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
author | S Σ | 1..1 | Reference(CAeReCPractitionerRole) | The source of the decision
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
source | S Σ | 1..1 | BackboneElement | Message source application
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
endpoint | S Σ | 1..1 | url | Actual message source address or id
reason | S Σ | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.
response | Σ | 0..1 | BackboneElement | If this is a reply to prior message
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
identifier | S Σ | 1..1 | id | Id of original message
code | S Σ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message.
details | S Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors
focus | S Σ | 1..* | Reference(CAeReCServiceRequest | CAeReCTask | CAeReCAppointment | CAeReCCommunication) | The actual content of the message
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
MessageHeader.event[x] | extensible | MessageEventCode `http://hl7.ca/fhir/eReferral/ValueSet/message-event-code` from this IG
MessageHeader.destination.receiver.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
MessageHeader.sender.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
MessageHeader.enterer.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
MessageHeader.author.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
MessageHeader.reason | example | ExampleMessageReasonCodes `http://hl7.org/fhir/ValueSet/message-reason-encounter` from the FHIR Standard
MessageHeader.response.code | required | ResponseType `http://hl7.org/fhir/ValueSet/response-code|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | 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 | error | 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 | error | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | MessageHeader | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
MessageHeader |  | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems
id | S Σ | 1..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.
Additional Bindings | Purpose
AllLanguages | Max Binding
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] | S Σ | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: Message Event Code (extensible)
destination | S Σ | 0..* | 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 | S Σ | 1..1 | url | Actual destination address or id
receiver | S Σ | 0..1 | Reference(CAeReCPractitioner | CAeReCPractitionerRole | CAeReCOrganization) | Intended "real-world" recipient for the data
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
display | Σ | 0..1 | string | Text alternative for the resource
sender | Σ | 0..1 | Reference(CAeReCPractitioner | CAeReCPractitionerRole | CAeReCOrganization) | Real world sender of the message
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
display | Σ | 0..1 | string | Text alternative for the resource
enterer | Σ | 0..1 | Reference(CAeReCPractitionerRole | CAeReCPractitioner) | The source of the data entry
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
display | Σ | 0..1 | string | Text alternative for the resource
author | S Σ | 1..1 | Reference(CAeReCPractitionerRole) | The source of the decision
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
display | Σ | 0..1 | string | Text alternative for the resource
source | S Σ | 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 | S Σ | 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: ExampleMessageReasonCodes (example): Reason for event occurrence.
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 | S Σ | 1..1 | id | Id of original message
code | S Σ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message.
details | S Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors
focus | S Σ | 1..* | Reference(CAeReCServiceRequest | CAeReCTask | CAeReCAppointment | CAeReCCommunication) | The actual content of the message
definition | Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
MessageHeader.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
MessageHeader.event[x] | extensible | MessageEventCode `http://hl7.ca/fhir/eReferral/ValueSet/message-event-code` from this IG
MessageHeader.destination.receiver.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
MessageHeader.destination.receiver.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
MessageHeader.destination.receiver.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
MessageHeader.sender.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
MessageHeader.sender.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
MessageHeader.sender.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
MessageHeader.enterer.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
MessageHeader.enterer.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
MessageHeader.enterer.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
MessageHeader.author.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
MessageHeader.author.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
MessageHeader.author.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
MessageHeader.reason | example | ExampleMessageReasonCodes `http://hl7.org/fhir/ValueSet/message-reason-encounter` from the FHIR Standard
MessageHeader.response.code | required | ResponseType `http://hl7.org/fhir/ValueSet/response-code|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | 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 | error | 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 | error | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | MessageHeader | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

This structure is derived from MessageHeader

Summary

Mandatory: 3 elements(8 nested mandatory elements)
Must-Support: 29 elements

Structures

This structure refers to these other structures:

- CAeReCPractitioner (http://hl7.ca/fhir/eReferral/StructureDefinition/CAeReCPractitioner)
- CAeReCPractitionerRole (http://hl7.ca/fhir/eReferral/StructureDefinition/CAeReCPractitionerRole)
- CAeReCOrganization (http://hl7.ca/fhir/eReferral/StructureDefinition/CAeReCOrganization)
- CAeReCServiceRequest (http://hl7.ca/fhir/eReferral/StructureDefinition/CAeReCServiceRequest)
- CAeReCTask (http://hl7.ca/fhir/eReferral/StructureDefinition/CAeReCTask)
- CAeReCAppointment (http://hl7.ca/fhir/eReferral/StructureDefinition/CAeReCAppointment)
- CAeReCCommunication (http://hl7.ca/fhir/eReferral/StructureDefinition/CAeReCCommunication)

Other representations of profile: CSV, Excel, Schematron