Patient Master Identity Registry (PMIR)
1.5.0 - Trial-Implementation
This page is part of the IHE Patient Master Identity Registry (PMIR) (v1.5.0: Trial Implementation) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Official URL: https://profiles.ihe.net/ITI/PMIR/StructureDefinition/IHE.PMIR.MessageHeader | Version: 1.5.0 | |||
Active as of 2022-08-08 | 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.
This structure is derived from MessageHeader
Summary
Mandatory: 3 elements
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
This structure is derived from MessageHeader
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
event[x] | 1..1 | uri | Code for the event this message represents or link to event definition Slice: Unordered, Open by type:$this | |
eventUri | 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/StructureDefintion/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 | string | 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 | ||||
Slices for event[x] | Σ | 1..1 | uri | Code for the event this message represents or link to event definition Slice: Unordered, Closed by type:$this Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. | ||||
event[x]:eventUri | Σ | 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/StructureDefintion/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 | |
sender | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message |
enterer | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry |
author | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision |
responsible | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event |
Documentation for this format |
This structure is derived from MessageHeader
Summary
Mandatory: 3 elements
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from MessageHeader
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
event[x] | 1..1 | uri | Code for the event this message represents or link to event definition Slice: Unordered, Open by type:$this | |
eventUri | 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/StructureDefintion/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 | string | 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 | ||||
Slices for event[x] | Σ | 1..1 | uri | Code for the event this message represents or link to event definition Slice: Unordered, Closed by type:$this Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. | ||||
event[x]:eventUri | Σ | 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/StructureDefintion/IHE.PMIR.MessageDefinition | ||||
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet / Code |
MessageHeader.language | preferred | CommonLanguages Max Binding: AllLanguages |
MessageHeader.event[x] | example | MessageEvent |
MessageHeader.event[x]:eventUri | example | Pattern: urn:ihe:iti:pmir:2019:patient-feed |
MessageHeader.reason | example | ExampleMessageReasonCodes |
MessageHeader.response.code | required | ResponseType |