Patient Master Identity Registry (PMIR)
1.5.1-current - ci-build
Patient Master Identity Registry (PMIR)
1.5.1-current - ci-build
Patient Master Identity Registry (PMIR), published by IHE IT Infrastructure Technical Committee. This guide is not an authorized publication; it is the continuous build for version 1.5.1-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/ITI.PMIR/ and changes regularly. See the Directory of published versions
| Official URL: https://profiles.ihe.net/ITI/PMIR/StructureDefinition/IHE.PMIR.MessageHeader | Version: 1.5.1-current | |||
| Active as of 2025-04-28 | Computable Name: PMIRMessageHeader | |||
StructureDefinition for MessageHeader resource constraints in the IHE PMIR Profile.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MessageHeader |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| event[x] |
Σ | 1..1 | uri | Code for the event this message represents or link to event definition Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. ele-1: All FHIR elements must have a @value or children Required Pattern: urn:ihe:iti:pmir:2019:patient-feed |
 destination |
Σ | 1..* | BackboneElement | Message destination application(s) ele-1: All FHIR elements must have a @value or children |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 endpoint |
Σ | 1..1 | url | Actual destination address or id ele-1: All FHIR elements must have a @value or children |
 sender |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message ele-1: All FHIR elements must have a @value or children |
| enterer |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry ele-1: All FHIR elements must have a @value or children |
| author |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision ele-1: All FHIR elements must have a @value or children |
| source |
Σ | 1..1 | BackboneElement | Message source application ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| endpoint |
Σ | 1..1 | url | Actual message source address or id ele-1: All FHIR elements must have a @value or children |
| responsible |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event ele-1: All FHIR elements must have a @value or children |
| focus |
Σ | 1..1 | Reference(IHE Patient Master Identity Registry Bundle Message) | The actual content of the message ele-1: All FHIR elements must have a @value or children |
| definition |
Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message ele-1: All FHIR elements must have a @value or children Required Pattern: https://profiles.ihe.net/ITI/PMIR/MessageDefinition/IHE.PMIR.MessageDefinition |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| MessageHeader.event[x] | example | Pattern: urn:ihe:iti:pmir:2019:patient-feedhttp://hl7.org/fhir/ValueSet/message-eventsfrom the FHIR Standard |
This structure is derived from MessageHeader
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader |
MessageHeader | |||
| event[x] |
1..1 | uri | Code for the event this message represents or link to event definition Required Pattern: urn:ihe:iti:pmir:2019:patient-feed | |
 destination |
1..* | BackboneElement | Message destination application(s) | |
| sender |
S | 0..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 |
S | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision |
| responsible |
S | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event |
| focus |
1..1 | Reference(IHE Patient Master Identity Registry Bundle Message) | The actual content of the message | |
| definition |
0..1 | canonical(MessageDefinition) | Link to the definition for this message Required Pattern: https://profiles.ihe.net/ITI/PMIR/MessageDefinition/IHE.PMIR.MessageDefinition | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MessageHeader |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| 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 | uri | Code for the event this message represents or link to event definition Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. Required Pattern: urn:ihe:iti:pmir:2019:patient-feed | ||||
| destination |
Σ | 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Σ | 0..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 |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision | ||||
| source |
Σ | 1..1 | BackboneElement | Message source application | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| 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 |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event | ||||
| reason |
Σ | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence. | ||||
| response |
Σ | 0..1 | BackboneElement | If this is a reply to prior message | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier |
Σ | 1..1 | id | Id of original message | ||||
| code |
Σ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. | ||||
| details |
Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | ||||
| focus |
Σ | 1..1 | Reference(IHE Patient Master Identity Registry Bundle Message) | The actual content of the message | ||||
| definition |
Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message Required Pattern: https://profiles.ihe.net/ITI/PMIR/MessageDefinition/IHE.PMIR.MessageDefinition | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| MessageHeader.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| MessageHeader.event[x] | example | Pattern: urn:ihe:iti:pmir:2019:patient-feedhttp://hl7.org/fhir/ValueSet/message-eventsfrom the FHIR Standard | ||||
| MessageHeader.reason | example | ExampleMessageReasonCodeshttp://hl7.org/fhir/ValueSet/message-reason-encounterfrom the FHIR Standard | ||||
| MessageHeader.response.code | required | ResponseTypehttp://hl7.org/fhir/ValueSet/response-code|4.0.1from the FHIR Standard |
This structure is derived from MessageHeader
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| event[x] |
Σ | 1..1 | uri | Code for the event this message represents or link to event definition Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. ele-1: All FHIR elements must have a @value or children Required Pattern: urn:ihe:iti:pmir:2019:patient-feed |
| destination |
Σ | 1..* | BackboneElement | Message destination application(s) ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| endpoint |
Σ | 1..1 | url | Actual destination address or id ele-1: All FHIR elements must have a @value or children |
| sender |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message ele-1: All FHIR elements must have a @value or children |
| enterer |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry ele-1: All FHIR elements must have a @value or children |
| author |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision ele-1: All FHIR elements must have a @value or children |
| source |
Σ | 1..1 | BackboneElement | Message source application ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| endpoint |
Σ | 1..1 | url | Actual message source address or id ele-1: All FHIR elements must have a @value or children |
| responsible |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event ele-1: All FHIR elements must have a @value or children |
| focus |
Σ | 1..1 | Reference(IHE Patient Master Identity Registry Bundle Message) | The actual content of the message ele-1: All FHIR elements must have a @value or children |
| definition |
Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message ele-1: All FHIR elements must have a @value or children Required Pattern: https://profiles.ihe.net/ITI/PMIR/MessageDefinition/IHE.PMIR.MessageDefinition |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| MessageHeader.event[x] | example | Pattern: urn:ihe:iti:pmir:2019:patient-feedhttp://hl7.org/fhir/ValueSet/message-eventsfrom the FHIR Standard |
Differential View
This structure is derived from MessageHeader
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader |
MessageHeader | |||
| event[x] |
1..1 | uri | Code for the event this message represents or link to event definition Required Pattern: urn:ihe:iti:pmir:2019:patient-feed | |
| destination |
1..* | BackboneElement | Message destination application(s) | |
| sender |
S | 0..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 |
S | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision |
| responsible |
S | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event |
| focus |
1..1 | Reference(IHE Patient Master Identity Registry Bundle Message) | The actual content of the message | |
| definition |
0..1 | canonical(MessageDefinition) | Link to the definition for this message Required Pattern: https://profiles.ihe.net/ITI/PMIR/MessageDefinition/IHE.PMIR.MessageDefinition | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MessageHeader |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| 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 | uri | Code for the event this message represents or link to event definition Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. Required Pattern: urn:ihe:iti:pmir:2019:patient-feed | ||||
| destination |
Σ | 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Σ | 0..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 |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision | ||||
| source |
Σ | 1..1 | BackboneElement | Message source application | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| 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 |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event | ||||
| reason |
Σ | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence. | ||||
| response |
Σ | 0..1 | BackboneElement | If this is a reply to prior message | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier |
Σ | 1..1 | id | Id of original message | ||||
| code |
Σ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. | ||||
| details |
Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | ||||
| focus |
Σ | 1..1 | Reference(IHE Patient Master Identity Registry Bundle Message) | The actual content of the message | ||||
| definition |
Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message Required Pattern: https://profiles.ihe.net/ITI/PMIR/MessageDefinition/IHE.PMIR.MessageDefinition | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| MessageHeader.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| MessageHeader.event[x] | example | Pattern: urn:ihe:iti:pmir:2019:patient-feedhttp://hl7.org/fhir/ValueSet/message-eventsfrom the FHIR Standard | ||||
| MessageHeader.reason | example | ExampleMessageReasonCodeshttp://hl7.org/fhir/ValueSet/message-reason-encounterfrom the FHIR Standard | ||||
| MessageHeader.response.code | required | ResponseTypehttp://hl7.org/fhir/ValueSet/response-code|4.0.1from the FHIR Standard |
This structure is derived from MessageHeader
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ IHE IT Infrastructure Technical Committee. Package ihe.iti.pmir#1.5.1-current based on FHIR 4.0.1. Generated 2025-04-28
Links: Table of Contents |
QA Report
| New Issue | Issues
Version History |
|
Propose a change