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/ e muda regularmente. Veja o Diretório de versões publicadas

## Resource Profile: PTMessageHeader

Official URL: http://example.com/fhir/hl7pt/StructureDefinition/MessageHeader-Pt | Version: 1.0.0
Active as of 2026-02-13 | Computable Name: PTMessageHeader

Perfil de MessageHeader para contexto de comunicação Messaging.

Usos:

- Este Perfil não é utilizado por nenhum perfil neste guia de implementação

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

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

Nome | Bandeiras | Card. | Tipo | Descrição e condicionalismos Filter: Condicionantes Obrigações Vínculos
--- | --- | --- | --- | ---
MessageHeader |  | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems
id | Σ | 1..1 | id | Logical id of this artifact
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
event[x] | Σ | 1..1 | Coding | Code for the event this message represents or link to event definition Vínculo: Eventos FHIR para Gestão de Identidade de Utentes (extensible)
destination | S Σ | 1..1 | BackboneElement | Message destination application(s)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
endpoint | Σ | 1..1 | url | Actual destination address or id
sender | S Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message
enterer | S Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry
source | S Σ | 1..1 | BackboneElement | Message source application
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
endpoint | Σ | 1..1 | url | Actual message source address or id
focus | S Σ | 1..* | Reference(Resource) | The actual content of the message
Documentação para este formato

#### Terminologia Ligações

Caminho | Estado | Utilização | Conjunto de valores | Versão | Fonte
MessageHeader.event[x] | Base | extensible | Eventos FHIR para Gestão de Identidade de Utentes | 📦1.0.0 | este IG

#### Restrições

Id | Grau | Caminho(s) | Descrição | Expressão
dom-2 | error | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | MessageHeader | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | MessageHeader | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from MessageHeader

Nome | Bandeiras | Card. | Tipo | Descrição e condicionalismos Filter: Condicionantes Obrigações Vínculos
--- | --- | --- | --- | ---
MessageHeader |  | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems
id |  | 1..1 | id | Logical id of this artifact
event[x] |  | 1..1 | Coding | Code for the event this message represents or link to event definition Vínculo: Eventos FHIR para Gestão de Identidade de Utentes (extensible)
destination | S | 1..1 | BackboneElement | Message destination application(s)
sender | S | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message
enterer | S | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry
source | S | 1..1 | BackboneElement | Message source application
focus | S | 1..* | Reference(Resource) | The actual content of the message
Documentação para este formato

#### Terminologia Ligações (Diferencial)

Caminho | Estado | Utilização | Conjunto de valores | Versão | Fonte
MessageHeader.event[x] | Base | extensible | Eventos FHIR para Gestão de Identidade de Utentes | 📦1.0.0 | este IG

Nome | Bandeiras | Card. | Tipo | Descrição e condicionalismos Filter: Condicionantes Obrigações Vínculos
--- | --- | --- | --- | ---
MessageHeader |  | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems
id | Σ | 1..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Vínculo: CommonLanguages (preferred): A human language.
Vínculos adicionais | Objetivo
AllLanguages | Vínculo máximo
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
event[x] | Σ | 1..1 | Coding | Code for the event this message represents or link to event definition Vínculo: Eventos FHIR para Gestão de Identidade de Utentes (extensible)
destination | S Σ | 1..1 | BackboneElement | Message destination application(s)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 0..1 | string | Name of system
target | Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination
endpoint | Σ | 1..1 | url | Actual destination address or id
receiver | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data
sender | S Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message
enterer | S Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry
author | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision
source | S Σ | 1..1 | BackboneElement | Message source application
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 0..1 | string | Name of system
software | Σ | 0..1 | string | Name of software running the system
version | Σ | 0..1 | string | Version of software running
contact | Σ | 0..1 | ContactPoint | Human contact for problems
endpoint | Σ | 1..1 | url | Actual message source address or id
responsible | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event
reason | Σ | 0..1 | CodeableConcept | Cause of event Vínculo: ExampleMessageReasonCodes (example): Reason for event occurrence.
response | Σ | 0..1 | BackboneElement | If this is a reply to prior message
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
identifier | Σ | 1..1 | id | Id of original message
code | Σ | 1..1 | code | ok | transient-error | fatal-error Vínculo: ResponseType (required): The kind of response to a message.
details | Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors
focus | S Σ | 1..* | Reference(Resource) | The actual content of the message
definition | Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message
Documentação para este formato

#### Terminologia Ligações

Caminho | Estado | Utilização | Conjunto de valores | Versão | Fonte
MessageHeader.language | Base | preferred | Common Languages | 📍4.0.1 | a norma FHIR
MessageHeader.event[x] | Base | extensible | Eventos FHIR para Gestão de Identidade de Utentes | 📦1.0.0 | este IG
MessageHeader.reason | Base | example | Example Message Reason Codes | 📍4.0.1 | a norma FHIR
MessageHeader.response.​code | Base | required | ResponseType | 📍4.0.1 | a norma FHIR

#### Restrições

Id | Grau | Caminho(s) | Descrição | Expressão
dom-2 | error | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | MessageHeader | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | MessageHeader | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from MessageHeader

Resumo

Obrigatório: 4 elementos
Deve ser suportado: 5 elementos

Key Elements View

Nome | Bandeiras | Card. | Tipo | Descrição e condicionalismos Filter: Condicionantes Obrigações Vínculos
--- | --- | --- | --- | ---
MessageHeader |  | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems
id | Σ | 1..1 | id | Logical id of this artifact
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
event[x] | Σ | 1..1 | Coding | Code for the event this message represents or link to event definition Vínculo: Eventos FHIR para Gestão de Identidade de Utentes (extensible)
destination | S Σ | 1..1 | BackboneElement | Message destination application(s)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
endpoint | Σ | 1..1 | url | Actual destination address or id
sender | S Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message
enterer | S Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry
source | S Σ | 1..1 | BackboneElement | Message source application
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
endpoint | Σ | 1..1 | url | Actual message source address or id
focus | S Σ | 1..* | Reference(Resource) | The actual content of the message
Documentação para este formato

#### Terminologia Ligações

Caminho | Estado | Utilização | Conjunto de valores | Versão | Fonte
MessageHeader.event[x] | Base | extensible | Eventos FHIR para Gestão de Identidade de Utentes | 📦1.0.0 | este IG

#### Restrições

Id | Grau | Caminho(s) | Descrição | Expressão
dom-2 | error | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | MessageHeader | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | MessageHeader | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Differential View

This structure is derived from MessageHeader

Nome | Bandeiras | Card. | Tipo | Descrição e condicionalismos Filter: Condicionantes Obrigações Vínculos
--- | --- | --- | --- | ---
MessageHeader |  | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems
id |  | 1..1 | id | Logical id of this artifact
event[x] |  | 1..1 | Coding | Code for the event this message represents or link to event definition Vínculo: Eventos FHIR para Gestão de Identidade de Utentes (extensible)
destination | S | 1..1 | BackboneElement | Message destination application(s)
sender | S | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message
enterer | S | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry
source | S | 1..1 | BackboneElement | Message source application
focus | S | 1..* | Reference(Resource) | The actual content of the message
Documentação para este formato

#### Terminologia Ligações (Diferencial)

Caminho | Estado | Utilização | Conjunto de valores | Versão | Fonte
MessageHeader.event[x] | Base | extensible | Eventos FHIR para Gestão de Identidade de Utentes | 📦1.0.0 | este IG

Snapshot View

Nome | Bandeiras | Card. | Tipo | Descrição e condicionalismos Filter: Condicionantes Obrigações Vínculos
--- | --- | --- | --- | ---
MessageHeader |  | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems
id | Σ | 1..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Vínculo: CommonLanguages (preferred): A human language.
Vínculos adicionais | Objetivo
AllLanguages | Vínculo máximo
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
event[x] | Σ | 1..1 | Coding | Code for the event this message represents or link to event definition Vínculo: Eventos FHIR para Gestão de Identidade de Utentes (extensible)
destination | S Σ | 1..1 | BackboneElement | Message destination application(s)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 0..1 | string | Name of system
target | Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination
endpoint | Σ | 1..1 | url | Actual destination address or id
receiver | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data
sender | S Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message
enterer | S Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry
author | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision
source | S Σ | 1..1 | BackboneElement | Message source application
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 0..1 | string | Name of system
software | Σ | 0..1 | string | Name of software running the system
version | Σ | 0..1 | string | Version of software running
contact | Σ | 0..1 | ContactPoint | Human contact for problems
endpoint | Σ | 1..1 | url | Actual message source address or id
responsible | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event
reason | Σ | 0..1 | CodeableConcept | Cause of event Vínculo: ExampleMessageReasonCodes (example): Reason for event occurrence.
response | Σ | 0..1 | BackboneElement | If this is a reply to prior message
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
identifier | Σ | 1..1 | id | Id of original message
code | Σ | 1..1 | code | ok | transient-error | fatal-error Vínculo: ResponseType (required): The kind of response to a message.
details | Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors
focus | S Σ | 1..* | Reference(Resource) | The actual content of the message
definition | Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message
Documentação para este formato

#### Terminologia Ligações

Caminho | Estado | Utilização | Conjunto de valores | Versão | Fonte
MessageHeader.language | Base | preferred | Common Languages | 📍4.0.1 | a norma FHIR
MessageHeader.event[x] | Base | extensible | Eventos FHIR para Gestão de Identidade de Utentes | 📦1.0.0 | este IG
MessageHeader.reason | Base | example | Example Message Reason Codes | 📍4.0.1 | a norma FHIR
MessageHeader.response.​code | Base | required | ResponseType | 📍4.0.1 | a norma FHIR

#### Restrições

Id | Grau | Caminho(s) | Descrição | Expressão
dom-2 | error | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | MessageHeader | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | MessageHeader | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from MessageHeader

Resumo

Obrigatório: 4 elementos
Deve ser suportado: 5 elementos

Other representations of profile: CSV, Excel, Schematron