Profiles & Operations > Profile: MessageHeader

Profile: MessageHeader

Canonical URL:http://ontariohealth.ca/fhir/StructureDefinition/ca-on-seris-profile-MessageHeader

Simplifier project page: MessageHeader

Derived from: MessageHeader (R4)

Formal Views of Profile Content

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

Differential View

idΣ0..1string
id0..1string
extensionC0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionC0..*Extension
modifierExtension?! C0..*Extension
id0..1string
extensionC0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeBinding
displayS Σ0..1string
userSelectedΣ0..1boolean
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
nameΣ0..1string
targetΣ0..1Reference(Device)
endpointΣ1..1url
receiverΣ0..1Reference(Practitioner | PractitionerRole | Organization)
senderΣ0..1Reference(Practitioner | PractitionerRole | Organization)
entererΣ0..1Reference(Practitioner | PractitionerRole)
authorΣ0..1Reference(Practitioner | PractitionerRole)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
nameΣ0..1string
softwareΣ0..1string
versionΣ0..1string
contactΣ0..1ContactPoint
endpointS Σ1..1url
responsibleΣ0..1Reference(Practitioner | PractitionerRole | Organization)
reasonΣ0..1CodeableConcept
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
identifierΣ1..1id
codeΣ1..1codeBinding
detailsΣ0..1Reference(OperationOutcome)
focusΣ0..*Reference(Resource)
definitionΣ0..1canonical(MessageDefinition)

Hybrid View

idΣ0..1string
id0..1string
extensionC0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionC0..*Extension
modifierExtension?! C0..*Extension
id0..1string
extensionC0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeBinding
displayS Σ0..1string
userSelectedΣ0..1boolean
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
nameΣ0..1string
targetΣ0..1Reference(Device)
endpointΣ1..1url
receiverΣ0..1Reference(Practitioner | PractitionerRole | Organization)
senderΣ0..1Reference(Practitioner | PractitionerRole | Organization)
entererΣ0..1Reference(Practitioner | PractitionerRole)
authorΣ0..1Reference(Practitioner | PractitionerRole)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
nameΣ0..1string
softwareΣ0..1string
versionΣ0..1string
contactΣ0..1ContactPoint
endpointS Σ1..1url
responsibleΣ0..1Reference(Practitioner | PractitionerRole | Organization)
reasonΣ0..1CodeableConcept
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
identifierΣ1..1id
codeΣ1..1codeBinding
detailsΣ0..1Reference(OperationOutcome)
focusΣ0..*Reference(Resource)
definitionΣ0..1canonical(MessageDefinition)

Snapshot View

idΣ0..1string
id0..1string
extensionC0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionC0..*Extension
modifierExtension?! C0..*Extension
id0..1string
extensionC0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeBinding
displayS Σ0..1string
userSelectedΣ0..1boolean
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
nameΣ0..1string
targetΣ0..1Reference(Device)
endpointΣ1..1url
receiverΣ0..1Reference(Practitioner | PractitionerRole | Organization)
senderΣ0..1Reference(Practitioner | PractitionerRole | Organization)
entererΣ0..1Reference(Practitioner | PractitionerRole)
authorΣ0..1Reference(Practitioner | PractitionerRole)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
nameΣ0..1string
softwareΣ0..1string
versionΣ0..1string
contactΣ0..1ContactPoint
endpointS Σ1..1url
responsibleΣ0..1Reference(Practitioner | PractitionerRole | Organization)
reasonΣ0..1CodeableConcept
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
identifierΣ1..1id
codeΣ1..1codeBinding
detailsΣ0..1Reference(OperationOutcome)
focusΣ0..*Reference(Resource)
definitionΣ0..1canonical(MessageDefinition)

Table View

MessageHeader..
MessageHeader.meta1..
MessageHeader.meta.profile1..
MessageHeader.event[x]Coding..
MessageHeader.event[x].system1..
MessageHeader.event[x].code1..
MessageHeader.event[x].display..
MessageHeader.source..
MessageHeader.source.endpoint..

JSON View

{
"resourceType": "StructureDefinition",
"id": "ca-on-seris-profile-MessageHeader",
"url": "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-seris-profile-MessageHeader",
"version": "1.0.1",
"name": "MessageHeader",
"title": "MessageHeader",
"status": "draft",
"date": "2023-03-02",
"publisher": "Ontario Health",
"contact": [
{
"name": "Ontario Health",
"telecom": [
{
"system": "url",
"value": "http://ontariohealth.ca/fhir/"
},
{
"system": "email",
"value": "some.email@ontariohealth.ca"
}
]
}
],
"description": "The header for a message exchange that is submitting data.",
"fhirVersion": "4.0.1",
"kind": "resource",
"abstract": false,
"type": "MessageHeader",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/MessageHeader",
"derivation": "constraint",
"element": [
{
"id": "MessageHeader.meta",
"path": "MessageHeader.meta",
"min": 1,
"mustSupport": true
},
{
"id": "MessageHeader.meta.profile",
"path": "MessageHeader.meta.profile",
"comment": "#### **_` FOR SERIS USAGE: The meta.profile = http://ontariohealth.ca/fhir/StructureDefinition/ca-on-seris-profile-MessageHeader|1.0.0 `_**\n\nIt is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.",
"min": 1,
"mustSupport": true
},
{
"id": "MessageHeader.event[x]",
"path": "MessageHeader.event[x]",
"type": [
{
"code": "Coding"
}
],
"mustSupport": true,
"binding": {
"strength": "extensible",
"description": "Code that identifies the event this message represents and connects it with its definition",
"valueSet": "http://ontariohealth.ca/fhir/ValueSet/message-event-code"
}
},
{
"id": "MessageHeader.event[x].system",
"path": "MessageHeader.event[x].system",
"min": 1,
"fixedUri": "http://ontariohealth.ca/fhir/CodeSystem/message-event-code",
"mustSupport": true
},
{
"id": "MessageHeader.event[x].code",
"path": "MessageHeader.event[x].code",
"min": 1,
"mustSupport": true,
"binding": {
"strength": "extensible",
"description": "Code that identifies the event this message represents and connects it with its definition.",
"valueSet": "http://ontariohealth.ca/fhir/ValueSet/message-event-code"
}
},
{
"id": "MessageHeader.event[x].display",
"path": "MessageHeader.event[x].display",
"mustSupport": true
},
{
"id": "MessageHeader.source",
"path": "MessageHeader.source",
"mustSupport": true
},
{
"id": "MessageHeader.source.endpoint",
"path": "MessageHeader.source.endpoint",
"mustSupport": true
}
]
}
}

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="ca-on-seris-profile-Bundle" />
<url value="http://ontariohealth.ca/fhir/StructureDefinition/ca-on-seris-profile-Bundle" />
<version value="1.0.1" />
<name value="Bundle" />
<title value="Bundle" />
<status value="draft" />
<date value="2023-03-10" />
<publisher value="Ontario Health" />
<system value="url" />
<value value="http://ontariohealth.ca/fhir/" />
</telecom>
<system value="email" />
<value value="some.email@ontariohealth.ca" />
</telecom>
</contact>
<description value="Constraints on Bundle resource ensuring that message is defined." />
<fhirVersion value="4.0.1" />
<identity value="v2" />
<uri value="http://hl7.org/v2" />
<name value="HL7 v2 Mapping" />
</mapping>
<identity value="rim" />
<uri value="http://hl7.org/v3" />
<name value="RIM Mapping" />
</mapping>
<identity value="cda" />
<uri value="http://hl7.org/v3/cda" />
<name value="CDA (R2)" />
</mapping>
<identity value="w5" />
<uri value="http://hl7.org/fhir/fivews" />
<name value="FiveWs Pattern Mapping" />
</mapping>
<kind value="resource" />
<abstract value="false" />
<type value="Bundle" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Bundle" />
<derivation value="constraint" />
<element id="Bundle.meta">
<path value="Bundle.meta" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Bundle.meta.profile">
<path value="Bundle.meta.profile" />
<comment value="#### **_` FOR SERIS USAGE: The meta.profile = http://ontariohealth.ca/fhir/StructureDefinition/ca-on-seris-profile-Bundle|1.0.0 `_**\n\nIt is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set." />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Bundle.meta.security">
<path value="Bundle.meta.security" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Bundle.meta.security.system">
<path value="Bundle.meta.security.system" />
<fixedUri value="http://terminology.hl7.org/CodeSystem/v3-ActReason" />
<mustSupport value="true" />
</element>
<element id="Bundle.meta.security.code">
<path value="Bundle.meta.security.code" />
<fixedCode value="HTEST" />
<mustSupport value="true" />
</element>
<element id="Bundle.meta.tag">
<path value="Bundle.meta.tag" />
<min value="1" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Bundle.meta.tag.system">
<path value="Bundle.meta.tag.system" />
<min value="1" />
<fixedUri value="https://fhir.infoway-inforoute.ca/NamingSystem/ca-on-health-care-facility-id" />
<mustSupport value="true" />
</element>
<element id="Bundle.meta.tag.code">
<path value="Bundle.meta.tag.code" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Bundle.identifier">
<path value="Bundle.identifier" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Bundle.identifier.system">
<path value="Bundle.identifier.system" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Bundle.identifier.value">
<path value="Bundle.identifier.value" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Bundle.type">
<path value="Bundle.type" />
<fixedCode value="message" />
<mustSupport value="true" />
</element>
<element id="Bundle.timestamp">
<path value="Bundle.timestamp" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Bundle.entry">
<path value="Bundle.entry" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Bundle.entry.fullUrl">
<path value="Bundle.entry.fullUrl" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Bundle.entry.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<mustSupport value="true" />
</element>
</differential>
</StructureDefinition>

Usage

MessageHeader is the first resource in the bundle and is used to define the entry for the submission of an OR Case with related resources in a Bundle. It also indicates the event that this message represents.

Notes

.meta.profile

  • used to declare conformance to this profile
  • populate with a fixed value: http://ontariohealth.ca/fhir/StructureDefinition/ca-on-seris-profile-MessageHeader

.eventCoding

  • indicate the type of message schedule of case

.source.endpoint

  • who is sending the message