STARS Implementation Guide
0.5.0 - release

STARS Implementation Guide - Downloaded Version 0.5.0 See the Directory of published versions

## Resource Profile: CSIRO STARS MessageHeader Profile

Official URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/csiro-stars-messageheader | Version: 0.5.0
Active as of 2025-09-08 | Computable Name: CsiroStarsMessageHeaderProfile

MessageHeader is used in bundles to assist directing to the correct destination

Usages:

- Examples for this Profile: MessageHeader/MessageHeader-DiagnosticReport and MessageHeader/MessageHeader-ServiceRequest

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
MessageHeader |  | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
contained |  | 0..* | Resource | Contained, inline Resources
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
event[x] | S Σ | 1..1 | Coding | Event code or link to EventDefinition Binding: STARS Message Type (required)
destination | Σ | 1..1 | BackboneElement | Message destination application(s)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
receiver | S Σ | 0..1 | Reference(CSIRO STARS Practitioner Profile) | Intended "real-world" recipient for the data
sender | S Σ | 0..1 | Reference(CSIRO STARS Practitioner Profile) | Real world sender of the message
author | S Σ | 0..1 | Reference(CSIRO STARS Practitioner Profile) | The source of the decision
source | Σ | 1..1 | BackboneElement | Message source application
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
MessageHeader.event[x] | required | MessageTypeValueSet(a valid code from STARS Message Type) `https://starsapi.csiro.au/fhir-ig/stars/ValueSet/message-type-value-set` From this IG

#### 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
MessageHeader |  | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems
event[x] | S | 1..1 | Coding | Event code or link to EventDefinition Binding: STARS Message Type (required)
destination |  | 1..1 | BackboneElement | Message destination application(s)
receiver | S | 0..1 | Reference(CSIRO STARS Practitioner Profile) | Intended "real-world" recipient for the data
sender | S | 0..1 | Reference(CSIRO STARS Practitioner Profile) | Real world sender of the message
author | S | 0..1 | Reference(CSIRO STARS Practitioner Profile) | The source of the decision
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
MessageHeader.event[x] | required | MessageTypeValueSet(a valid code from STARS Message Type) `https://starsapi.csiro.au/fhir-ig/stars/ValueSet/message-type-value-set` From this IG

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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: AllLanguages (required): IETF language tag for a human language
Additional Bindings | Purpose
CommonLanguages | Starter
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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 | Event code or link to EventDefinition Binding: STARS Message Type (required)
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
endpoint[x] | Σ | 0..1 |  | Actual destination address or Endpoint resource
endpointUrl |  |  | url |
endpointReference |  |  | Reference(Endpoint) |
name | Σ | 0..1 | string | Name of system
target | Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination
receiver | S Σ | 0..1 | Reference(CSIRO STARS Practitioner Profile) | Intended "real-world" recipient for the data
sender | S Σ | 0..1 | Reference(CSIRO STARS Practitioner Profile) | Real world sender of the message
author | S Σ | 0..1 | Reference(CSIRO STARS Practitioner Profile) | 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
endpoint[x] | Σ | 0..1 |  | Actual source address or Endpoint resource
endpointUrl |  |  | url |
endpointReference |  |  | Reference(Endpoint) |
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
responsible | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event
reason | Σ | 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 | Σ | 1..1 | Identifier | Bundle.identifier 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 | Σ | 0..* | Reference(Resource) | 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 | required | AllLanguages `http://hl7.org/fhir/ValueSet/all-languages|5.0.0` From the FHIR Standard
MessageHeader.event[x] | required | MessageTypeValueSet(a valid code from STARS Message Type) `https://starsapi.csiro.au/fhir-ig/stars/ValueSet/message-type-value-set` From this IG
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|5.0.0` 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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: 1 element
Must-Support: 4 elements

Structures

This structure refers to these other structures:

- CSIRO STARS Practitioner Profile (https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/csiro-stars-practitioner)

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
MessageHeader |  | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
contained |  | 0..* | Resource | Contained, inline Resources
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
event[x] | S Σ | 1..1 | Coding | Event code or link to EventDefinition Binding: STARS Message Type (required)
destination | Σ | 1..1 | BackboneElement | Message destination application(s)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
receiver | S Σ | 0..1 | Reference(CSIRO STARS Practitioner Profile) | Intended "real-world" recipient for the data
sender | S Σ | 0..1 | Reference(CSIRO STARS Practitioner Profile) | Real world sender of the message
author | S Σ | 0..1 | Reference(CSIRO STARS Practitioner Profile) | The source of the decision
source | Σ | 1..1 | BackboneElement | Message source application
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
MessageHeader.event[x] | required | MessageTypeValueSet(a valid code from STARS Message Type) `https://starsapi.csiro.au/fhir-ig/stars/ValueSet/message-type-value-set` From this IG

#### 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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() |

Differential View

This structure is derived from MessageHeader

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
MessageHeader |  | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems
event[x] | S | 1..1 | Coding | Event code or link to EventDefinition Binding: STARS Message Type (required)
destination |  | 1..1 | BackboneElement | Message destination application(s)
receiver | S | 0..1 | Reference(CSIRO STARS Practitioner Profile) | Intended "real-world" recipient for the data
sender | S | 0..1 | Reference(CSIRO STARS Practitioner Profile) | Real world sender of the message
author | S | 0..1 | Reference(CSIRO STARS Practitioner Profile) | The source of the decision
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
MessageHeader.event[x] | required | MessageTypeValueSet(a valid code from STARS Message Type) `https://starsapi.csiro.au/fhir-ig/stars/ValueSet/message-type-value-set` From this IG

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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: AllLanguages (required): IETF language tag for a human language
Additional Bindings | Purpose
CommonLanguages | Starter
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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 | Event code or link to EventDefinition Binding: STARS Message Type (required)
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
endpoint[x] | Σ | 0..1 |  | Actual destination address or Endpoint resource
endpointUrl |  |  | url |
endpointReference |  |  | Reference(Endpoint) |
name | Σ | 0..1 | string | Name of system
target | Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination
receiver | S Σ | 0..1 | Reference(CSIRO STARS Practitioner Profile) | Intended "real-world" recipient for the data
sender | S Σ | 0..1 | Reference(CSIRO STARS Practitioner Profile) | Real world sender of the message
author | S Σ | 0..1 | Reference(CSIRO STARS Practitioner Profile) | 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
endpoint[x] | Σ | 0..1 |  | Actual source address or Endpoint resource
endpointUrl |  |  | url |
endpointReference |  |  | Reference(Endpoint) |
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
responsible | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event
reason | Σ | 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 | Σ | 1..1 | Identifier | Bundle.identifier 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 | Σ | 0..* | Reference(Resource) | 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 | required | AllLanguages `http://hl7.org/fhir/ValueSet/all-languages|5.0.0` From the FHIR Standard
MessageHeader.event[x] | required | MessageTypeValueSet(a valid code from STARS Message Type) `https://starsapi.csiro.au/fhir-ig/stars/ValueSet/message-type-value-set` From this IG
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|5.0.0` 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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: 1 element
Must-Support: 4 elements

Structures

This structure refers to these other structures:

- CSIRO STARS Practitioner Profile (https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/csiro-stars-practitioner)

Other representations of profile: CSV, Excel, Schematron