Patient Master Identity Registry (PMIR)
1.5.0 - Trial-Implementation International flag

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

Resource Profile: IHE Patient Master Identity Registry MessageHeader

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:

Formal Views of Profile Content

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:

  • The element MessageHeader.event[x] is sliced based on the value of type:$this

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... event[x] 1..1uriCode for the event this message represents or link to event definition
Slice: Unordered, Open by type:$this
... eventUri 1..1uriCode for the event this message represents or link to event definition
Required Pattern: urn:ihe:iti:pmir:2019:patient-feed
... destination 1..*BackboneElementMessage destination application(s)
... sender S0..1Reference(Practitioner | PractitionerRole | Organization)Real world sender of the message
... enterer S0..1Reference(Practitioner | PractitionerRole)The source of the data entry
... author S0..1Reference(Practitioner | PractitionerRole)The source of the decision
... responsible S0..1Reference(Practitioner | PractitionerRole | Organization)Final responsibility for event
... focus 1..1Reference(IHE Patient Master Identity Registry Bundle Message)The actual content of the message
... definition 0..1canonical(MessageDefinition)Link to the definition for this message
Required Pattern: https://profiles.ihe.net/ITI/PMIR/StructureDefintion/IHE.PMIR.MessageDefinition

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for event[x] Σ1..1uriCode 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..1uriCode 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..*BackboneElementMessage destination application(s)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ0..1stringName of system
.... target Σ0..1Reference(Device)Particular delivery destination within the destination
.... endpoint Σ1..1urlActual destination address or id
.... receiver Σ0..1Reference(Practitioner | PractitionerRole | Organization)Intended "real-world" recipient for the data
... sender SΣ0..1Reference(Practitioner | PractitionerRole | Organization)Real world sender of the message
... enterer SΣ0..1Reference(Practitioner | PractitionerRole)The source of the data entry
... author SΣ0..1Reference(Practitioner | PractitionerRole)The source of the decision
... source Σ1..1BackboneElementMessage source application
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ0..1stringName of system
.... software Σ0..1stringName of software running the system
.... version Σ0..1stringVersion of software running
.... contact Σ0..1ContactPointHuman contact for problems
.... endpoint Σ1..1urlActual message source address or id
... responsible SΣ0..1Reference(Practitioner | PractitionerRole | Organization)Final responsibility for event
... reason Σ0..1CodeableConceptCause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.

... response Σ0..1BackboneElementIf this is a reply to prior message
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ1..1idId of original message
.... code Σ1..1codeok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details Σ0..1Reference(OperationOutcome)Specific list of hints/warnings/errors
... focus Σ1..1Reference(IHE Patient Master Identity Registry Bundle Message)The actual content of the message
... definition Σ0..1canonical(MessageDefinition)Link to the definition for this message
Required Pattern: https://profiles.ihe.net/ITI/PMIR/StructureDefintion/IHE.PMIR.MessageDefinition

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... sender Σ0..1Reference(Practitioner | PractitionerRole | Organization)Real world sender of the message
... enterer Σ0..1Reference(Practitioner | PractitionerRole)The source of the data entry
... author Σ0..1Reference(Practitioner | PractitionerRole)The source of the decision
... responsible Σ0..1Reference(Practitioner | PractitionerRole | Organization)Final responsibility for event

doco 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:

  • The element MessageHeader.event[x] is sliced based on the value of type:$this

Differential View

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... event[x] 1..1uriCode for the event this message represents or link to event definition
Slice: Unordered, Open by type:$this
... eventUri 1..1uriCode for the event this message represents or link to event definition
Required Pattern: urn:ihe:iti:pmir:2019:patient-feed
... destination 1..*BackboneElementMessage destination application(s)
... sender S0..1Reference(Practitioner | PractitionerRole | Organization)Real world sender of the message
... enterer S0..1Reference(Practitioner | PractitionerRole)The source of the data entry
... author S0..1Reference(Practitioner | PractitionerRole)The source of the decision
... responsible S0..1Reference(Practitioner | PractitionerRole | Organization)Final responsibility for event
... focus 1..1Reference(IHE Patient Master Identity Registry Bundle Message)The actual content of the message
... definition 0..1canonical(MessageDefinition)Link to the definition for this message
Required Pattern: https://profiles.ihe.net/ITI/PMIR/StructureDefintion/IHE.PMIR.MessageDefinition

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for event[x] Σ1..1uriCode 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..1uriCode 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..*BackboneElementMessage destination application(s)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ0..1stringName of system
.... target Σ0..1Reference(Device)Particular delivery destination within the destination
.... endpoint Σ1..1urlActual destination address or id
.... receiver Σ0..1Reference(Practitioner | PractitionerRole | Organization)Intended "real-world" recipient for the data
... sender SΣ0..1Reference(Practitioner | PractitionerRole | Organization)Real world sender of the message
... enterer SΣ0..1Reference(Practitioner | PractitionerRole)The source of the data entry
... author SΣ0..1Reference(Practitioner | PractitionerRole)The source of the decision
... source Σ1..1BackboneElementMessage source application
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ0..1stringName of system
.... software Σ0..1stringName of software running the system
.... version Σ0..1stringVersion of software running
.... contact Σ0..1ContactPointHuman contact for problems
.... endpoint Σ1..1urlActual message source address or id
... responsible SΣ0..1Reference(Practitioner | PractitionerRole | Organization)Final responsibility for event
... reason Σ0..1CodeableConceptCause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.

... response Σ0..1BackboneElementIf this is a reply to prior message
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ1..1idId of original message
.... code Σ1..1codeok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details Σ0..1Reference(OperationOutcome)Specific list of hints/warnings/errors
... focus Σ1..1Reference(IHE Patient Master Identity Registry Bundle Message)The actual content of the message
... definition Σ0..1canonical(MessageDefinition)Link to the definition for this message
Required Pattern: https://profiles.ihe.net/ITI/PMIR/StructureDefintion/IHE.PMIR.MessageDefinition

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
MessageHeader.languagepreferredCommonLanguages
Max Binding: AllLanguages
MessageHeader.event[x]exampleMessageEvent
MessageHeader.event[x]:eventUriexamplePattern: urn:ihe:iti:pmir:2019:patient-feed
MessageHeader.reasonexampleExampleMessageReasonCodes
MessageHeader.response.coderequiredResponseType