HL7 PT FHIR Implementation Guide: Example IG Release 1 | STU1
1.0.0 - STU1

HL7 PT FHIR Implementation Guide: Example IG Release 1 | STU1, publicado por HL7 Portugal. Este guia não é uma publicação autorizada; é a compilação contínua para a versão 1.0.0 construída pela FHIR (HL7® FHIR® Standard) CI Build. Esta versão é baseada no conteúdo atual de https://github.com/hl7-pt/patient-admin-ig/tree/master e muda regularmente. Veja o Diretório de versões publicadas

## Resource Profile: PTMessageHeader - Detailed Descriptions

Active as of 2026-02-13

Definitions for the MessageHeader-Pt resource profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

Instruções sobre como interpretar o conteúdo desta tabela podem ser encontradashere

0. MessageHeader
Definição | 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.
Curto | A resource that describes a message that is exchanged between systems
Controlo | 0..*
É modificador | false
Resumo | false
Invariantes | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.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-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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. MessageHeader.id
Definição | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Curto | Logical id of this artifact
Comentários | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Controlo | 10..1
Tipo | id string
É modificador | false
Resumo | true
4. MessageHeader.implicitRules
Definição | 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.
Curto | A set of rules under which this content was created
Comentários | 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.
Controlo | 0..1
Tipo | uri
É modificador | true porque This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. MessageHeader.modifierExtension
Definição | 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).
Curto | Extensions that cannot be ignored
Comentários | 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.
Controlo | 0..*
Tipo | Extension
É modificador | true porque Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Resumo | false
Requisitos | 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.
Nomes alternativos | extensions, user content
Invariantes | 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())
8. MessageHeader.event[x]
Definição | 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.
Curto | Code for the event this message represents or link to event definition
Comentários | The time of the event will be found in the focus resource. The time of the message will be found in Bundle.timestamp. The time of the event will be found in the focus resource. The time of the message will be found in Bundle.timestamp.
Controlo | 1..1
Vínculo | A menos que não sejam adequados, estes códigos DEVERÃO ser retirados de Para exemplos de códigos, ver Eventos FHIR para Gestão de Identidade de Utentes http://hl7.org/fhir/ValueSet/message-events|4.0.1 (extensible to `http://example.com/fhir/hl7pt/ValueSet/vs-patient-identity-events` )
Tipo | Coding, uri
[x] Nota | VerEscolha de tipos de dadospara mais informações sobre como utilizar [x]
É modificador | false
Resumo | true
Requisitos | Drives the behavior associated with this message.
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. MessageHeader.destination
Definição | The destination application which the message is intended for.
Curto | Message destination application(s)
Comentários | There SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.
Controlo | 10..1*
Tipo | BackboneElement
É modificador | false
Deve apoiar | true
Resumo | true
Requisitos | Indicates where message is to be sent for routing purposes. Allows verification of "am I the intended recipient".
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. MessageHeader.destination.modifierExtension
Definição | 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).
Curto | Extensions that cannot be ignored even if unrecognized
Comentários | 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.
Controlo | 0..*
Tipo | Extension
É modificador | true porque Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Resumo | true
Requisitos | 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.
Nomes alternativos | extensions, user content, modifiers
Invariantes | 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())
14. MessageHeader.destination.endpoint
Definição | Indicates where the message should be routed to.
Curto | Actual destination address or id
Comentários | The id may be a non-resolvable URI for systems that do not use standard network-based addresses.
Controlo | 1..1
Tipo | url
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | true
Requisitos | Identifies where to route the message.
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. MessageHeader.sender
Definição | Identifies the sending system to allow the use of a trust relationship.
Curto | Real world sender of the message
Comentários | Use case is for where a (trusted) sending system is responsible for multiple organizations, and therefore cannot differentiate based on source endpoint / authentication alone.
Controlo | 10..1
Tipo | Reference(Practitioner, PractitionerRole, Organization)
É modificador | false
Deve apoiar | true
Tipos de suporte obrigatório | Não há regras de suporte obrigatório sobre a escolha de tipos/perfis
Resumo | true
Requisitos | Allows routing beyond just the application level.
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. MessageHeader.enterer
Definição | 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.
Curto | The source of the data entry
Comentários | Usually only for the request but can be used in a response.
Controlo | 0..1
Tipo | Reference(Practitioner, PractitionerRole)
É modificador | false
Deve apoiar | true
Tipos de suporte obrigatório | Não há regras de suporte obrigatório sobre a escolha de tipos/perfis
Resumo | true
Requisitos | Need to know for audit/traceback requirements and possibly for authorization.
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. MessageHeader.source
Definição | The source application from which this message originated.
Curto | Message source application
Controlo | 1..1
Tipo | BackboneElement
É modificador | false
Deve apoiar | true
Resumo | true
Requisitos | Allows replies, supports audit.
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. MessageHeader.source.modifierExtension
Definição | 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).
Curto | Extensions that cannot be ignored even if unrecognized
Comentários | 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.
Controlo | 0..*
Tipo | Extension
É modificador | true porque Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Resumo | true
Requisitos | 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.
Nomes alternativos | extensions, user content, modifiers
Invariantes | 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())
24. MessageHeader.source.endpoint
Definição | Identifies the routing target to send acknowledgements to.
Curto | Actual message source address or id
Comentários | The id may be a non-resolvable URI for systems that do not use standard network-based addresses.
Controlo | 1..1
Tipo | url
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | true
Requisitos | Identifies where to send responses, may influence security permissions.
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. MessageHeader.focus
Definição | The actual data of the message - a reference to the root/focus class of the event.
Curto | The actual content of the message
Comentários | 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.
Controlo | 10..*
Tipo | Reference(Resource)
É modificador | false
Deve apoiar | true
Resumo | true
Requisitos | 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.
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Instruções sobre como interpretar o conteúdo desta tabela podem ser encontradashere

0. MessageHeader
2. MessageHeader.id
Controlo | 1..?
4. MessageHeader.event[x]
Vínculo | A menos que não sejam adequados, estes códigos DEVERÃO ser retirados de Eventos FHIR para Gestão de Identidade de Utentes (extensible to `http://example.com/fhir/hl7pt/ValueSet/vs-patient-identity-events` )
Tipo | Coding, uri
[x] Nota | VerEscolha de tipos de dadospara mais informações sobre como utilizar [x]
6. MessageHeader.destination
Controlo | 1..1
Deve apoiar | true
8. MessageHeader.sender
Controlo | 1..?
Deve apoiar | true
10. MessageHeader.enterer
Deve apoiar | true
12. MessageHeader.source
Deve apoiar | true
14. MessageHeader.focus
Controlo | 1..?
Deve apoiar | true

Instruções sobre como interpretar o conteúdo desta tabela podem ser encontradashere

0. MessageHeader
Definição | 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.
Curto | A resource that describes a message that is exchanged between systems
Controlo | 0..*
É modificador | false
Resumo | false
Invariantes | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.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-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-5: If a resource is contained in another resource, it SHALL NOT have a security label (`contained.meta.security.empty()`) dom-6: A resource should have narrative for robust management (`text.`div`.exists()`)
2. MessageHeader.id
Definição | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Curto | Logical id of this artifact
Comentários | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Controlo | 1..1
Tipo | id
É modificador | false
Resumo | true
4. MessageHeader.meta
Definição | 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.
Curto | Metadata about the resource
Controlo | 0..1
Tipo | Meta
É modificador | false
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. MessageHeader.implicitRules
Definição | 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.
Curto | A set of rules under which this content was created
Comentários | 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.
Controlo | 0..1
Tipo | uri
É modificador | true porque This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
8. MessageHeader.language
Definição | The base language in which the resource is written.
Curto | Language of the resource content
Comentários | 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).
Controlo | 0..1
Vínculo | Os códigos DEVERÃO ser retirados de CommonLanguages (preferred to `http://hl7.org/fhir/ValueSet/languages|4.0.1` ) A human language.
Vínculos adicionais | Objetivo
AllLanguages | Vínculo máximo
Tipo | code
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | false
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
10. MessageHeader.text
Definição | 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.
Curto | Text summary of the resource, for human interpretation
Comentários | 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.
Controlo | 0..1
Tipo | Narrative
É modificador | false
Resumo | false
Nomes alternativos | narrative, html, xhtml, display
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
12. MessageHeader.contained
Definição | 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.
Curto | Contained, inline Resources
Comentários | 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.
Controlo | 0..*
Tipo | Resource
É modificador | false
Resumo | false
Nomes alternativos | inline resources, anonymous resources, contained resources
14. MessageHeader.extension
Definição | 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.
Curto | Additional content defined by implementations
Comentários | 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.
Controlo | 0..*
Tipo | Extension
É modificador | false
Resumo | false
Nomes alternativos | extensions, user content
Invariantes | 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()`)
16. MessageHeader.modifierExtension
Definição | 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).
Curto | Extensions that cannot be ignored
Comentários | 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.
Controlo | 0..*
Tipo | Extension
É modificador | true porque Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Resumo | false
Requisitos | 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.
Nomes alternativos | extensions, user content
Invariantes | 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()`)
18. MessageHeader.event[x]
Definição | 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.
Curto | Code for the event this message represents or link to event definition
Comentários | The time of the event will be found in the focus resource. The time of the message will be found in Bundle.timestamp.
Controlo | 1..1
Vínculo | A menos que não sejam adequados, estes códigos DEVERÃO ser retirados de Eventos FHIR para Gestão de Identidade de Utentes (extensible to `http://example.com/fhir/hl7pt/ValueSet/vs-patient-identity-events` )
Tipo | Coding
[x] Nota | VerEscolha de tipos de dadospara mais informações sobre como utilizar [x]
É modificador | false
Resumo | true
Requisitos | Drives the behavior associated with this message.
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
20. MessageHeader.destination
Definição | The destination application which the message is intended for.
Curto | Message destination application(s)
Comentários | There SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.
Controlo | 1..1
Tipo | BackboneElement
É modificador | false
Deve apoiar | true
Resumo | true
Requisitos | Indicates where message is to be sent for routing purposes. Allows verification of "am I the intended recipient".
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. MessageHeader.destination.id
Definição | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Curto | Unique id for inter-element referencing
Controlo | 0..1
Tipo | string
É modificador | false
Formato XML | No formato XML, esta propriedade é representada como um atributo.
Resumo | false
24. MessageHeader.destination.extension
Definição | 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.
Curto | Additional content defined by implementations
Comentários | 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.
Controlo | 0..*
Tipo | Extension
É modificador | false
Resumo | false
Nomes alternativos | extensions, user content
Invariantes | 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()`)
26. MessageHeader.destination.modifierExtension
Definição | 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).
Curto | Extensions that cannot be ignored even if unrecognized
Comentários | 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.
Controlo | 0..*
Tipo | Extension
É modificador | true porque Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Resumo | true
Requisitos | 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.
Nomes alternativos | extensions, user content, modifiers
Invariantes | 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()`)
28. MessageHeader.destination.name
Definição | Human-readable name for the target system.
Curto | Name of system
Controlo | 0..1
Tipo | string
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | true
Requisitos | May be used for routing of response and/or to support audit.
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
30. MessageHeader.destination.target
Definição | Identifies the target end system in situations where the initial message transmission is to an intermediary system.
Curto | Particular delivery destination within the destination
Controlo | 0..1
Tipo | Reference(Device)
É modificador | false
Resumo | true
Requisitos | Supports multi-hop routing.
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
32. MessageHeader.destination.endpoint
Definição | Indicates where the message should be routed to.
Curto | Actual destination address or id
Comentários | The id may be a non-resolvable URI for systems that do not use standard network-based addresses.
Controlo | 1..1
Tipo | url
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | true
Requisitos | Identifies where to route the message.
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
34. MessageHeader.destination.receiver
Definição | Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.
Curto | Intended "real-world" recipient for the data
Controlo | 0..1
Tipo | Reference(Practitioner, PractitionerRole, Organization)
É modificador | false
Resumo | true
Requisitos | Allows routing beyond just the application level.
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
36. MessageHeader.sender
Definição | Identifies the sending system to allow the use of a trust relationship.
Curto | Real world sender of the message
Comentários | Use case is for where a (trusted) sending system is responsible for multiple organizations, and therefore cannot differentiate based on source endpoint / authentication alone.
Controlo | 1..1
Tipo | Reference(Practitioner, PractitionerRole, Organization)
É modificador | false
Deve apoiar | true
Tipos de suporte obrigatório | Não há regras de suporte obrigatório sobre a escolha de tipos/perfis
Resumo | true
Requisitos | Allows routing beyond just the application level.
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
38. MessageHeader.enterer
Definição | 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.
Curto | The source of the data entry
Comentários | Usually only for the request but can be used in a response.
Controlo | 0..1
Tipo | Reference(Practitioner, PractitionerRole)
É modificador | false
Deve apoiar | true
Tipos de suporte obrigatório | Não há regras de suporte obrigatório sobre a escolha de tipos/perfis
Resumo | true
Requisitos | Need to know for audit/traceback requirements and possibly for authorization.
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
40. MessageHeader.author
Definição | 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.
Curto | The source of the decision
Comentários | Usually only for the request but can be used in a response.
Controlo | 0..1
Tipo | Reference(Practitioner, PractitionerRole)
É modificador | false
Resumo | true
Requisitos | Need to know for audit/traceback requirements and possibly for authorization.
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
42. MessageHeader.source
Definição | The source application from which this message originated.
Curto | Message source application
Controlo | 1..1
Tipo | BackboneElement
É modificador | false
Deve apoiar | true
Resumo | true
Requisitos | Allows replies, supports audit.
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
44. MessageHeader.source.id
Definição | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Curto | Unique id for inter-element referencing
Controlo | 0..1
Tipo | string
É modificador | false
Formato XML | No formato XML, esta propriedade é representada como um atributo.
Resumo | false
46. MessageHeader.source.extension
Definição | 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.
Curto | Additional content defined by implementations
Comentários | 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.
Controlo | 0..*
Tipo | Extension
É modificador | false
Resumo | false
Nomes alternativos | extensions, user content
Invariantes | 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()`)
48. MessageHeader.source.modifierExtension
Definição | 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).
Curto | Extensions that cannot be ignored even if unrecognized
Comentários | 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.
Controlo | 0..*
Tipo | Extension
É modificador | true porque Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Resumo | true
Requisitos | 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.
Nomes alternativos | extensions, user content, modifiers
Invariantes | 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()`)
50. MessageHeader.source.name
Definição | Human-readable name for the source system.
Curto | Name of system
Controlo | 0..1
Tipo | string
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | true
Requisitos | May be used to support audit.
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
52. MessageHeader.source.software
Definição | May include configuration or other information useful in debugging.
Curto | Name of software running the system
Controlo | 0..1
Tipo | string
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | true
Requisitos | Supports audit and possibly interface engine behavior.
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
54. MessageHeader.source.version
Definição | Can convey versions of multiple systems in situations where a message passes through multiple hands.
Curto | Version of software running
Nota | Este é um ID de versão comercial, não um ID de versão de recurso (ver discussão)
Controlo | 0..1
Tipo | string
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | true
Requisitos | Supports audit and possibly interface engine behavior.
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
56. MessageHeader.source.contact
Definição | An e-mail, phone, website or other contact point to use to resolve issues with message communications.
Curto | Human contact for problems
Controlo | 0..1
Tipo | ContactPoint
É modificador | false
Resumo | true
Requisitos | Allows escalation of technical issues.
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
58. MessageHeader.source.endpoint
Definição | Identifies the routing target to send acknowledgements to.
Curto | Actual message source address or id
Comentários | The id may be a non-resolvable URI for systems that do not use standard network-based addresses.
Controlo | 1..1
Tipo | url
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | true
Requisitos | Identifies where to send responses, may influence security permissions.
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
60. MessageHeader.responsible
Definição | 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.
Curto | Final responsibility for event
Comentários | Usually only for the request but can be used in a response.
Controlo | 0..1
Tipo | Reference(Practitioner, PractitionerRole, Organization)
É modificador | false
Resumo | true
Requisitos | Need to know for audit/traceback requirements and possibly for authorization.
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
62. MessageHeader.reason
Definição | Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.
Curto | Cause of event
Controlo | 0..1
Vínculo | Para exemplos de códigos, ver ExampleMessageReasonCodes (example to `http://hl7.org/fhir/ValueSet/message-reason-encounter|4.0.1` ) Reason for event occurrence.
Tipo | CodeableConcept
É modificador | false
Resumo | true
Requisitos | Need to be able to track why resources are being changed and report in the audit log/history of the resource. May affect authorization.
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
64. MessageHeader.response
Definição | Information about the message that this message is a response to. Only present if this message is a response.
Curto | If this is a reply to prior message
Controlo | 0..1
Tipo | BackboneElement
É modificador | false
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
66. MessageHeader.response.id
Definição | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Curto | Unique id for inter-element referencing
Controlo | 0..1
Tipo | string
É modificador | false
Formato XML | No formato XML, esta propriedade é representada como um atributo.
Resumo | false
68. MessageHeader.response.extension
Definição | 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.
Curto | Additional content defined by implementations
Comentários | 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.
Controlo | 0..*
Tipo | Extension
É modificador | false
Resumo | false
Nomes alternativos | extensions, user content
Invariantes | 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()`)
70. MessageHeader.response.modifierExtension
Definição | 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).
Curto | Extensions that cannot be ignored even if unrecognized
Comentários | 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.
Controlo | 0..*
Tipo | Extension
É modificador | true porque Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Resumo | true
Requisitos | 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.
Nomes alternativos | extensions, user content, modifiers
Invariantes | 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()`)
72. MessageHeader.response.identifier
Definição | The MessageHeader.id of the message to which this message is a response.
Curto | Id of original message
Nota | Trata-se de um identificador de empresa e não de um identificador de recurso (ver discussão)
Controlo | 1..1
Tipo | id
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | true
Requisitos | Allows receiver to know what message is being responded to.
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
74. MessageHeader.response.code
Definição | Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not.
Curto | ok | transient-error | fatal-error
Comentários | This is a generic response to the request message. Specific data for the response will be found in MessageHeader.focus.
Controlo | 1..1
Vínculo | Os códigos DEVERÃO ser retirados de ResponseType (required to `http://hl7.org/fhir/ValueSet/response-code|4.0.1` ) The kind of response to a message.
Tipo | code
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | true
Requisitos | Allows the sender of the acknowledge message to know if the request was successful or if action is needed.
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
76. MessageHeader.response.details
Definição | Full details of any issues found in the message.
Curto | Specific list of hints/warnings/errors
Comentários | This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error.
Controlo | 0..1
Tipo | Reference(OperationOutcome)
É modificador | false
Resumo | true
Requisitos | Allows the sender of the message to determine what the specific issues are.
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
78. MessageHeader.focus
Definição | The actual data of the message - a reference to the root/focus class of the event.
Curto | The actual content of the message
Comentários | 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.
Controlo | 1..*
Tipo | Reference(Resource)
É modificador | false
Deve apoiar | true
Resumo | true
Requisitos | 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.
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
80. MessageHeader.definition
Definição | Permanent link to the MessageDefinition for this message.
Curto | Link to the definition for this message
Controlo | 0..1
Tipo | canonical(MessageDefinition)
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | true
Requisitos | Allows sender to define the expected contents of the message.
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)