MessageHeader (En-tête de message)

URL canonique https://extranet.ti.msss.rtss.qc.ca/FHIR/eReferral/StructureDefinition/EReferralMessageHeader

Lien Simplifier https://simplifier.net/qc---ereferral-quebec/ereferralmessageheader

Ressource de base (R4) MessageHeader (R4)

Profil de la ressource

idS Σ1..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
eventUriuri
id0..1string
extensionC0..*Extension
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
nameΣ0..1string
targetΣ C0..1Reference(Device)
endpointS Σ1..1url
receiverS Σ C0..1Reference(https://extranet.ti.msss.rtss.qc.ca/FHIR/eReferral/EReferralPractitionerRole)
senderΣ C0..1Reference(Organization | Practitioner | PractitionerRole)
entererΣ C0..1Reference(Practitioner | PractitionerRole)
authorS Σ C1..1Reference(EReferralPractitionerRole)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
nameS Σ0..1string
softwareS Σ0..1string
versionΣ0..1string
contactΣ C0..1ContactPoint
endpointS Σ1..1url
responsibleΣ C0..1Reference(Organization | Practitioner | PractitionerRole)
reasonΣ0..1CodeableConcept
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
identifierΣ1..1id
codeΣ1..1codeBinding
detailsΣ C0..1Reference(OperationOutcome)
focusS Σ C1..*Reference(EReferralAppointment | https://extranet.ti.msss.rtss.qc.ca/FHIR/eReferral/StructureDefinition/EReferralRequest | EReferralTask)
definitionΣ0..1canonical(MessageDefinition)
idS Σ1..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
eventUriuri
id0..1string
extensionC0..*Extension
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
nameΣ0..1string
targetΣ C0..1Reference(Device)
endpointS Σ1..1url
receiverS Σ C0..1Reference(https://extranet.ti.msss.rtss.qc.ca/FHIR/eReferral/EReferralPractitionerRole)
senderΣ C0..1Reference(Organization | Practitioner | PractitionerRole)
entererΣ C0..1Reference(Practitioner | PractitionerRole)
authorS Σ C1..1Reference(EReferralPractitionerRole)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
nameS Σ0..1string
softwareS Σ0..1string
versionΣ0..1string
contactΣ C0..1ContactPoint
endpointS Σ1..1url
responsibleΣ C0..1Reference(Organization | Practitioner | PractitionerRole)
reasonΣ0..1CodeableConcept
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
identifierΣ1..1id
codeΣ1..1codeBinding
detailsΣ C0..1Reference(OperationOutcome)
focusS Σ C1..*Reference(EReferralAppointment | https://extranet.ti.msss.rtss.qc.ca/FHIR/eReferral/StructureDefinition/EReferralRequest | EReferralTask)
definitionΣ0..1canonical(MessageDefinition)
MessageHeader
ShortA resource that describes a message that is exchanged between systems
Definition

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.

Cardinality0..*
Constraints
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    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-6: A resource should have narrative for robust management
    text.`div`.exists()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
Mappings
  • rim: Entity. Role, or Act
  • v2: MSH / MSA / ERR
  • rim: Message
MessageHeader.id
ShortLogical id of this artifact
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

MessageHeader.meta
ShortMetadata about the resource
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Cardinality0..1
TypeMeta
Must SupportTrue
SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
MessageHeader.meta.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MessageHeader.meta.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MessageHeader.meta.versionId
ShortVersion specific identifier
Definition

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

Cardinality0..1
Typeid
SummaryTrue
Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
MessageHeader.meta.lastUpdated
ShortWhen the resource version last changed
Definition

When the resource last changed - e.g. when the version changed.

Cardinality0..1
Typeinstant
SummaryTrue
Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
MessageHeader.meta.source
ShortIdentifies where the resource comes from
Definition

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

Cardinality0..1
Typeuri
SummaryTrue
Comments

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
MessageHeader.meta.profile
ShortProfiles this resource claims to conform to
Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Cardinality1..*
Typecanonical(StructureDefinition)
Must SupportTrue
SummaryTrue
Comments

Profils à laquelle cette ressource se conforme : https://extranet.ti.msss.rtss.qc.ca/FHIR/eReferral/EReferralMessageHeader|1.0.0

**_` FOR eREFERRAL USAGE: The meta.profile = https://extranet.ti.msss.rtss.qc.ca/FHIR/eReferral/MessageHeader|1.0.0

It 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.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
MessageHeader.meta.security
ShortSecurity Labels applied to this resource
Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Cardinality0..*
TypeCoding
Binding

Security Labels from the Healthcare Privacy and Security Classification System.

All Security Labels (extensible)

SummaryTrue
Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
MessageHeader.meta.tag
ShortTags applied to this resource
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Cardinality0..*
TypeCoding
Binding

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

CommonTags (example)

SummaryTrue
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
MessageHeader.implicitRules
ShortA set of rules under which this content was created
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Cardinality0..1
Typeuri
ModifierTrue
SummaryTrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
MessageHeader.language
ShortLanguage of the resource content
Definition

The base language in which the resource is written.

Cardinality0..1
Typecode
Binding

A human language.

CommonLanguages (preferred)

Binding extensions
maxValueSetAllLanguages
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
MessageHeader.text
ShortText summary of the resource, for human interpretation
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Cardinality0..1
TypeNarrative
Aliasnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
MessageHeader.contained
ShortContained, inline Resources
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Cardinality0..*
TypeResource
Aliasinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Mappings
  • rim: Entity. Role, or Act
  • rim: N/A
MessageHeader.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MessageHeader.modifierExtension
ShortExtensions that cannot be ignored
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality0..*
TypeExtension
ModifierTrue
Aliasextensions, user content
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MessageHeader.event[x]
ShortCode for the event this message represents or link to event definition
Definition

Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://terminology.hl7.org/CodeSystem/message-events". Alternatively uri to the EventDefinition.

Cardinality1..1
TypeCoding | uri
Binding

One of the message events defined as part of this version of FHIR.

MessageEvent (example)

Must SupportTrue
SummaryTrue
Requirements

Drives the behavior associated with this message.

Comments

The time of the event will be found in the focus resource. The time of the message will be found in Bundle.timestamp.

Slicing

Unordered, Open, by $this(Type)

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.what[x]
  • v2: MSH-9.2
  • rim: ./payload[classCode="CACT" and moodCode="EVN" and isNormalAct()]/code[isNormalDatatype()]/code
MessageHeader.event[x]:eventCoding
ShortCode for the event this message represents or link to event definition
Definition

Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://terminology.hl7.org/CodeSystem/message-events". Alternatively uri to the EventDefinition.

Cardinality0..1
TypeCoding
Binding

One of the message events defined as part of this version of FHIR.

https://extranet.ti.msss.rtss.qc.ca/FHIR/eReferral/EvenementMessage (extensible)

Must SupportTrue
SummaryTrue
Requirements

Drives the behavior associated with this message.

Comments

The time of the event will be found in the focus resource. The time of the message will be found in Bundle.timestamp.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.what[x]
  • v2: MSH-9.2
  • rim: ./payload[classCode="CACT" and moodCode="EVN" and isNormalAct()]/code[isNormalDatatype()]/code
MessageHeader.event[x]:eventCoding.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MessageHeader.event[x]:eventCoding.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MessageHeader.event[x]:eventCoding.system
ShortIdentity of the terminology system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality0..1
Typeuri
Must SupportTrue
SummaryTrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
MessageHeader.event[x]:eventCoding.version
ShortVersion of the system - if relevant
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Cardinality0..1
Typestring
SummaryTrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
MessageHeader.event[x]:eventCoding.code
ShortSymbol in syntax defined by the system
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Cardinality0..1
Typecode
Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
MessageHeader.event[x]:eventCoding.display
ShortRepresentation defined by the system
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality0..1
Typestring
Must SupportTrue
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
MessageHeader.event[x]:eventCoding.userSelected
ShortIf this coding was chosen directly by the user
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Cardinality0..1
Typeboolean
SummaryTrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
MessageHeader.destination
ShortMessage destination application(s)
Definition

The destination application which the message is intended for.

Cardinality1..*
TypeBackboneElement
Must SupportTrue
SummaryTrue
Requirements

Indicates where message is to be sent for routing purposes. Allows verification of "am I the intended recipient".

Comments

There SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.subject[x]
  • rim: ./communicationFunction[typeCode="RCV"]
  • w5: FiveWs.subject
MessageHeader.destination.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MessageHeader.destination.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MessageHeader.destination.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MessageHeader.destination.name
ShortName of system
Definition

Human-readable name for the target system.

Cardinality0..1
Typestring
SummaryTrue
Requirements

May be used for routing of response and/or to support audit.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: MSH-5
  • rim: unique(./entity[determinerCode="INST" and (classCode=("DEV", "PSN", "ORG"]/name[type='ST' and isNormalDatatype()])
MessageHeader.destination.target
ShortParticular delivery destination within the destination
Definition

Identifies the target end system in situations where the initial message transmission is to an intermediary system.

Cardinality0..1
TypeReference(Device)
SummaryTrue
Requirements

Supports multi-hop routing.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: unique(./entity[determinerCode="INST" and (classCode=("DEV", "PSN", "ORG"]
MessageHeader.destination.endpoint
ShortActual destination address or id
Definition

Indicates where the message should be routed to.

Cardinality1..1
Typeurl
Must SupportTrue
SummaryTrue
Requirements

Identifies where to route the message.

Comments

The id may be a non-resolvable URI for systems that do not use standard network-based addresses.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: MSH-25 (or MSH-6)
  • rim: ./telecom
MessageHeader.destination.receiver
ShortIntended "real-world" recipient for the data
Definition

Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.

Cardinality0..1
TypeReference(https://extranet.ti.msss.rtss.qc.ca/FHIR/eReferral/EReferralPractitionerRole)
Must SupportTrue
SummaryTrue
Requirements

Allows routing beyond just the application level.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.subject[x]
  • v2: PRT-5:PRT-4='WAYR' / PRT-8:PRT-4='WAYR'
  • rim: Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText
  • w5: FiveWs.subject
MessageHeader.sender
ShortReal world sender of the message
Definition

Identifies the sending system to allow the use of a trust relationship.

Cardinality0..1
TypeReference(Organization | Practitioner | PractitionerRole)
SummaryTrue
Requirements

Allows routing beyond just the application level.

Comments

Use case is for where a (trusted) sending system is responsible for multiple organizations, and therefore cannot differentiate based on source endpoint / authentication alone.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.subject[x]
  • v2: PRT-5:PRT-4='WAYR' / PRT-8:PRT-4='WAYR'
  • rim: Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText
  • w5: FiveWs.subject
MessageHeader.enterer
ShortThe source of the data entry
Definition

The person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions.

Cardinality0..1
TypeReference(Practitioner | PractitionerRole)
SummaryTrue
Requirements

Need to know for audit/traceback requirements and possibly for authorization.

Comments

Usually only for the request but can be used in a response.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • v2: EVN-5 / ORC-10 / PRT-5:PRT-4='EP' / ROL where ROL.3 is EP or ORC.10
  • rim: unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[typeCode="ENT" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/player[isNormalEntity() and classCode=("DEV", "PSN") and determinerCode="INST"])
MessageHeader.author
ShortThe source of the decision
Definition

The logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.

Cardinality1..1
TypeReference(EReferralPractitionerRole)
Must SupportTrue
SummaryTrue
Requirements

Need to know for audit/traceback requirements and possibly for authorization.

Comments

Usually only for the request but can be used in a response.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • v2: ORC-19 / PRT-5:PRT-4='AUT' / ROL where ROL.3 is IP or ORC.12
  • rim: unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode="AUT" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/player[isNormalEntity() and classCode=("DEV", "PSN") and determinerCode="INST"])
MessageHeader.source
ShortMessage source application
Definition

The source application from which this message originated.

Cardinality1..1
TypeBackboneElement
Must SupportTrue
SummaryTrue
Requirements

Allows replies, supports audit.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.actor
  • rim: unique(./communicationFunction[typeCode="SND"])
MessageHeader.source.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MessageHeader.source.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MessageHeader.source.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MessageHeader.source.name
ShortName of system
Definition

Human-readable name for the source system.

Cardinality0..1
Typestring
Must SupportTrue
SummaryTrue
Requirements

May be used to support audit.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: MSH-3
  • rim: unique(./entity[determinerCode="INST" and classCode="DEV"]/name[type='ST' and isNormalDatatype()])
MessageHeader.source.software
ShortName of software running the system
Definition

May include configuration or other information useful in debugging.

Cardinality0..1
Typestring
Must SupportTrue
SummaryTrue
Requirements

Supports audit and possibly interface engine behavior.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: SFT-3 ( +SFT-1)
  • rim: unique(./entity[determinerCode="INST" and classCode="DEV"]/softwareName[isNormalDatatype()])
MessageHeader.source.version
ShortVersion of software running
Definition

Can convey versions of multiple systems in situations where a message passes through multiple hands.

Cardinality0..1
Typestring
SummaryTrue
Requirements

Supports audit and possibly interface engine behavior.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: SFT-2
  • rim: (Not supported)
MessageHeader.source.contact
ShortHuman contact for problems
Definition

An e-mail, phone, website or other contact point to use to resolve issues with message communications.

Cardinality0..1
TypeContactPoint
SummaryTrue
Requirements

Allows escalation of technical issues.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cpt-2: A system is required if a value is provided.
    value.empty() or system.exists()
Mappings
  • rim: n/a
  • v2: XTN
  • rim: TEL
  • servd: ContactPoint
  • v2: (MSH-22?)
  • rim: unique(./entity[determinerCode="INST" and classCode="DEV"]/scopesRole[normalRole() and classCode="CON" and layer[classCode="PSN"]/telecom[isNormalDatatype()])
MessageHeader.source.endpoint
ShortActual message source address or id
Definition

Identifies the routing target to send acknowledgements to.

Cardinality1..1
Typeurl
Must SupportTrue
SummaryTrue
Requirements

Identifies where to send responses, may influence security permissions.

Comments

The id may be a non-resolvable URI for systems that do not use standard network-based addresses.

Establishes the namespace for the value - that is, a URL that describes a set values that are unique. URI qui identifie le systeme qu'a genéré le numero du dossier de l'usager. Format: http://ca.qc.[CodeRegion].[CodeEtablissement].[CodeSite]/IdentifiantSysteme

[CodeRegion]: ex. 1- Bas Saint laurent - https://www.msss.gouv.qc.ca/reseau/regions-sociosanitaires-du-quebec/ [CodeEtablissement] ]: code d'etablissement - extrait du M02 pour le public [CodeSite]: code site - extrait du M02 pour le public IdentifiantSysteme (obligatoire): identifier de maniere unique un systeme source

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: MSH-24
  • rim: ./telecom[isNormalDatatype()]
MessageHeader.responsible
ShortFinal responsibility for event
Definition

The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party.

Cardinality0..1
TypeReference(Organization | Practitioner | PractitionerRole)
SummaryTrue
Requirements

Need to know for audit/traceback requirements and possibly for authorization.

Comments

Usually only for the request but can be used in a response.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.witness
  • v2: ORC-12 / PRT-5:PRT-4='OP' / PRT-8:PRT-4='OP' / ROL where ROL.3 is RO or ORC.11
  • rim: unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode="RESP" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/player[isNormalEntity() and classCode="PSN" and determinerCode="INST"] or ./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode="RESP" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/scoper[isNormalEntity() and classCode="ORG" and determinerCode="INST"])
MessageHeader.reason
ShortCause of event
Definition

Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.

Cardinality0..1
TypeCodeableConcept
Binding

Reason for event occurrence.

ExampleMessageReasonCodes (example)

SummaryTrue
Requirements

Need to be able to track why resources are being changed and report in the audit log/history of the resource. May affect authorization.

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.why[x]
  • v2: EVN.4 / ORC.16 / OBR-31-reason for study / BPO-13-BP indication for use / RXO-20-indication / RXE-27-give indication / RXD-21-indication / RXG-22-indication / RXA-19-indication
  • rim: unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/reasonCode[isNormalDatatype()])
MessageHeader.response
ShortIf this is a reply to prior message
Definition

Information about the message that this message is a response to. Only present if this message is a response.

Cardinality0..1
TypeBackboneElement
SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: MSA
  • rim: ./conveyedAcknowledgement
MessageHeader.response.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MessageHeader.response.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MessageHeader.response.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MessageHeader.response.identifier
ShortId of original message
Definition

The MessageHeader.id of the message to which this message is a response.

Cardinality1..1
Typeid
SummaryTrue
Requirements

Allows receiver to know what message is being responded to.

Comments

RFC 4122

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: MSA-2
  • rim: ./acknowledges.id[isNormalDatatype()]
MessageHeader.response.code
Shortok | transient-error | fatal-error
Definition

Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not.

Cardinality1..1
Typecode
Binding

The kind of response to a message.

ResponseType (required)

SummaryTrue
Requirements

Allows the sender of the acknowledge message to know if the request was successful or if action is needed.

Comments

This is a generic response to the request message. Specific data for the response will be found in MessageHeader.focus.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: MSA-1
  • rim: ./typeCode[isNormalDatatype()]
MessageHeader.response.details
ShortSpecific list of hints/warnings/errors
Definition

Full details of any issues found in the message.

Cardinality0..1
TypeReference(OperationOutcome)
SummaryTrue
Requirements

Allows the sender of the message to determine what the specific issues are.

Comments

This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • v2: ERR
  • rim: AcknowledgementDetail or Observation[classCode="ALRT" and moodCode="EVN"]
MessageHeader.focus
ShortThe actual content of the message
Definition

The actual data of the message - a reference to the root/focus class of the event.

Cardinality1..*
TypeReference(EReferralAppointment | https://extranet.ti.msss.rtss.qc.ca/FHIR/eReferral/StructureDefinition/EReferralRequest | EReferralTask)
Must SupportTrue
SummaryTrue
Requirements

Every message event is about actual data, a single resource, that is identified in the definition of the event, and perhaps some or all linked resources.

Comments

The data is defined where the transaction type is defined. The transaction data is always included in the bundle that is the full message. Only the root resource is specified. The resources it references should be contained in the bundle but are not also listed here. Multiple repetitions are allowed to cater for merges and other situations with multiple focal targets.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[typeCode="SUBJ" and isNormalParticipation]/role or ./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/outboundRelationship[typeCode="SBJ" and isNormalActRelatoinship]/target)
MessageHeader.definition
ShortLink to the definition for this message
Definition

Permanent link to the MessageDefinition for this message.

Cardinality0..1
Typecanonical(MessageDefinition)
SummaryTrue
Requirements

Allows sender to define the expected contents of the message.

Comments
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: Not directly supported.
{
"resourceType": "StructureDefinition",
"id": "EReferralMessageHeader",
"url": "https://extranet.ti.msss.rtss.qc.ca/FHIR/eReferral/StructureDefinition/EReferralMessageHeader",
"version": "1.0.0",
"name": "EReferralMessageHeader",
"status": "draft",
"date": "2024-04-10T18:33:54.6627357+00:00",
"fhirVersion": "4.0.1",
"kind": "resource",
"abstract": false,
"type": "MessageHeader",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/MessageHeader",
"derivation": "constraint",
"element": [
{
"id": "MessageHeader.id",
"path": "MessageHeader.id",
"min": 1,
"mustSupport": true
},
{
"id": "MessageHeader.meta",
"path": "MessageHeader.meta",
"mustSupport": true
},
{
"id": "MessageHeader.meta.profile",
"path": "MessageHeader.meta.profile",
"comment": "Profils à laquelle cette ressource se conforme : https://extranet.ti.msss.rtss.qc.ca/FHIR/eReferral/EReferralMessageHeader|1.0.0\n\n\n#### **_` FOR eREFERRAL USAGE: The meta.profile = https://extranet.ti.msss.rtss.qc.ca/FHIR/eReferral/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]",
"slicing": {
{
"type": "type",
"path": "$this"
}
],
"rules": "open"
},
"mustSupport": true
},
{
"id": "MessageHeader.event[x]:eventCoding",
"path": "MessageHeader.event[x]",
"sliceName": "eventCoding",
"type": [
{
"code": "Coding"
}
],
"mustSupport": true,
"binding": {
"strength": "extensible",
"valueSet": "https://extranet.ti.msss.rtss.qc.ca/FHIR/eReferral/EvenementMessage"
}
},
{
"id": "MessageHeader.event[x]:eventCoding.system",
"path": "MessageHeader.event[x].system",
"mustSupport": true
},
{
"id": "MessageHeader.event[x]:eventCoding.code",
"path": "MessageHeader.event[x].code",
"mustSupport": true
},
{
"id": "MessageHeader.event[x]:eventCoding.display",
"path": "MessageHeader.event[x].display",
"mustSupport": true
},
{
"id": "MessageHeader.destination",
"path": "MessageHeader.destination",
"min": 1,
"mustSupport": true
},
{
"id": "MessageHeader.destination.endpoint",
"path": "MessageHeader.destination.endpoint",
"mustSupport": true
},
{
"id": "MessageHeader.destination.receiver",
"path": "MessageHeader.destination.receiver",
"type": [
{
"code": "Reference",
"https://extranet.ti.msss.rtss.qc.ca/FHIR/eReferral/EReferralPractitionerRole"
]
}
],
"mustSupport": true
},
{
"id": "MessageHeader.author",
"path": "MessageHeader.author",
"min": 1,
"type": [
{
"code": "Reference",
"https://extranet.ti.msss.rtss.qc.ca/FHIR/eReferral/StructureDefinition/EReferralPractitionerRole"
]
}
],
"mustSupport": true
},
{
"id": "MessageHeader.source",
"path": "MessageHeader.source",
"mustSupport": true
},
{
"id": "MessageHeader.source.name",
"path": "MessageHeader.source.name",
"mustSupport": true
},
{
"id": "MessageHeader.source.software",
"path": "MessageHeader.source.software",
"mustSupport": true
},
{
"id": "MessageHeader.source.endpoint",
"path": "MessageHeader.source.endpoint",
"comment": "The id may be a non-resolvable URI for systems that do not use standard network-based addresses.\n\n\n\nEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. URI qui identifie le systeme qu'a genéré le numero du dossier de l'usager. Format: http://ca.qc.[CodeRegion].[CodeEtablissement].[CodeSite]/IdentifiantSysteme\n\n[CodeRegion]: ex. 1- Bas Saint laurent - https://www.msss.gouv.qc.ca/reseau/regions-sociosanitaires-du-quebec/ [CodeEtablissement] ]: code d'etablissement - extrait du M02 pour le public [CodeSite]: code site - extrait du M02 pour le public IdentifiantSysteme (obligatoire): identifier de maniere unique un systeme source",
"mustSupport": true
},
{
"id": "MessageHeader.focus",
"path": "MessageHeader.focus",
"min": 1,
"type": [
{
"code": "Reference",
"https://extranet.ti.msss.rtss.qc.ca/FHIR/eReferral/StructureDefinition/EReferralTask",
"https://extranet.ti.msss.rtss.qc.ca/FHIR/eReferral/StructureDefinition/EReferralAppointment",
"https://extranet.ti.msss.rtss.qc.ca/FHIR/eReferral/StructureDefinition/EReferralRequest"
],
"referenced"
]
}
],
"mustSupport": true
}
]
}
}

Utilisation

La ressource MessageHeader est la première entrée du Bundle et est utilisée pour spécifier l'événement déclencheur et de fournir des informations pour le routage du message.

La ressource MessageHeader sert d'enveloppe pour un message qui transporte des données d'une application à une autre. Cette ressource pointe par le biais de l'attribut focus soit vers une ressource Tâche, soit vers une ressource Rendez-vous.

Notes

.id

  • Identifiant unique de la ressource MessageHeader.
  • En cas d'absence d'un identifiant unique reconnu lors de la construction d'un Bundle de communication, un UUID devrait être utilisé dans cet élément (avec une valeur correspondante dans Bundle.entry.fullUrl )

.meta.profile

  • Permet de déclarer la conformité au présent profil
  • DOIT être renseigné avec la valeur attendue suivante :

https://extranet.ti.msss.rtss.qc.ca/FHIR/eReferral/StructureDefinition/EReferralMessageHeader|1.0.0

.event.eventCoding

Événement déclencheur de la ressource MessageHeader.

NOTE: Pour un bundle 02 'rendez-vous', utilisez le code 308817005 (Informations sur le rendez-vous octroyé).

This value set includes codes from the following code systems:

  • The following codes from system: 55091000087107

    CodeDisplayDesignation (fr)Designation (en)
    308817005Appointment status (finding)Changement de statut (Informations sur le rendez-vous octroyé)Appointment status
    308625005Request status (finding)état de la requête (Changement de statut)Request status
    54761000087101Reclassified request (finding)requête avec nouvelle priorité (Changement de priorité)Reclassified request
    55081000087105Forwarded request (finding)requête transmise (Réassignation à un autre CRDS)Forwarded request

.destination.receiver

Référence de type PractionnerRole qui sert à indentifier le destinataire des données.

.destination.endpoint

Point d'accès visé. Pour SAFIR, renseigner à cette valeur fixe :

https://safirapss.rtss.qc.ca/SaFHIR/fhir/$processMessage

.author.reference

Référence vers un PractionnerRole qui sert à indentifier l'auteur de la tâche ou du rendez-vous.

.source.name

Nom du système à l'origine du message.

.source.software

Logiciel à l'origine du message

.source.endpoint

URI qui identifie le systeme qu'a genéré le message. Format: http://ca.qc.[CodeRegion].[CodeEtablissement].[CodeSite]/IdentifiantSysteme

.focus

  • DOIT être renseigné avec une Référence soit vers une ressource Tâche, soit vers une ressource Rendez-vous.