FHIR Data Standards Wales for PSOM v1.0.0-rc4

Important: This is the release candidate of the FHIR Data Standards Wales for PSOM version 1.0.0-rc4 Implementation Guide. It is intended for trial use, and is published for early comment and feedback. Click here to give feedback.

DataStandardsWales-PSOM-MessageHeader

Profile	Description	Status	URL
Data Standards Wales PSOM MessageHeader	A profile that defines a MessageHeader structure used for PSOM messaging.	active	https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-PSOM-MessageHeader

Formal Views of Profile Content

Snapshot View
Differential View
Hybrid View
Mappings
Examples

DataStandardsWalesPSOMMessageHeader (MessageHeader)

MessageHeader

Element id

MessageHeader

Short description

A resource that describes a message that is exchanged between systems

Definition

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.

Data type

MessageHeader

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.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-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-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
PSOM-MessageHeader-01: All exception response messages must include a fully specified response (including an OperationOutcome that contains the issue details).
event.code = 'exception-response' implies (response.details.exists())

Mappings

rim: Entity. Role, or Act
v2: MSH / MSA / ERR
rim: Message

0..1

string

There are no (further) constraints on this element

Element id

MessageHeader.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

string

Meta

There are no (further) constraints on this element

Element id

MessageHeader.meta

Short description

Metadata about the resource

Definition

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.

Data type

Meta

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..1

uri

There are no (further) constraints on this element

Element id

MessageHeader.implicitRules

Short description

A set of rules under which this content was created

Definition

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.

Comments

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.

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

MessageHeader.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

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).

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

text

0..1

Narrative

There are no (further) constraints on this element

Element id

MessageHeader.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

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.

Comments

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.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..*

Resource

There are no (further) constraints on this element

Element id

MessageHeader.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

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.

Comments

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.

Data type

Resource

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..*

Extension

There are no (further) constraints on this element

Element id

MessageHeader.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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.

Comments

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

?! C

0..*

Extension

There are no (further) constraints on this element

Element id

MessageHeader.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

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).

Requirements

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.

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

event[x]

Σ C

1..1

Binding

Element id

MessageHeader.event[x]

Short description

Code for the event this message represents or link to event definition

Definition

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.

Requirements

Drives the behavior associated with this message.

Comments

The time of the event will be found in the focus resource. The time of the message will be found in Bundle.timestamp.

Binding

PSOM message events

DataStandardsWalesPSOMMessageEvent (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, PSOM-MessageHeader-01

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.what[x]
v2: MSH-9.2
rim: ./payload[classCode="CACT" and moodCode="EVN" and isNormalAct()]/code[isNormalDatatype()]/code

eventCoding

Coding

Data type

Coding

destination

0..*

BackboneElement

There are no (further) constraints on this element

Element id

MessageHeader.destination

Short description

Message destination application(s)

Definition

The destination application which the message is intended for.

Requirements

Indicates where message is to be sent for routing purposes. Allows verification of "am I the intended recipient".

Comments

There SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.subject[x]
rim: ./communicationFunction[typeCode="RCV"]
w5: FiveWs.subject

0..1

string

There are no (further) constraints on this element

Element id

MessageHeader.destination.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

MessageHeader.destination.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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.

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

MessageHeader.destination.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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).

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

name

0..1

string

There are no (further) constraints on this element

Element id

MessageHeader.destination.name

Short description

Name of system

Definition

Human-readable name for the target system.

Requirements

May be used for routing of response and/or to support audit.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: MSH-5
rim: unique(./entity[determinerCode="INST" and (classCode=("DEV", "PSN", "ORG"]/name[type='ST' and isNormalDatatype()])

target

Σ C

0..1

Reference(Device)

There are no (further) constraints on this element

Element id

MessageHeader.destination.target

Short description

Particular delivery destination within the destination

Definition

Identifies the target end system in situations where the initial message transmission is to an intermediary system.

Requirements

Supports multi-hop routing.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: unique(./entity[determinerCode="INST" and (classCode=("DEV", "PSN", "ORG"]

endpoint

1..1

url

There are no (further) constraints on this element

Element id

MessageHeader.destination.endpoint

Short description

Actual destination address or id

Definition

Indicates where the message should be routed to.

Requirements

Identifies where to route the message.

Comments

The id may be a non-resolvable URI for systems that do not use standard network-based addresses.

Data type

url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: MSH-25 (or MSH-6)
rim: ./telecom

receiver

Σ C

0..1

Reference(Organization | Practitioner | PractitionerRole)

There are no (further) constraints on this element

Element id

MessageHeader.destination.receiver

Short description

Intended "real-world" recipient for the data

Definition

Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.

Requirements

Allows routing beyond just the application level.

Comments

Data type

Reference(Organization | Practitioner | PractitionerRole)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.subject[x]
v2: PRT-5:PRT-4='WAYR' / PRT-8:PRT-4='WAYR'
rim: Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText
w5: FiveWs.subject

sender

Σ C

0..1

Reference(Organization | Practitioner | PractitionerRole)

There are no (further) constraints on this element

Element id

MessageHeader.sender

Short description

Real world sender of the message

Definition

Identifies the sending system to allow the use of a trust relationship.

Requirements

Allows routing beyond just the application level.

Comments

Use case is for where a (trusted) sending system is responsible for multiple organizations, and therefore cannot differentiate based on source endpoint / authentication alone.

Data type

Reference(Organization | Practitioner | PractitionerRole)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.subject[x]
v2: PRT-5:PRT-4='WAYR' / PRT-8:PRT-4='WAYR'
rim: Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText
w5: FiveWs.subject

enterer

Σ C

0..1

Reference(Practitioner | PractitionerRole)

There are no (further) constraints on this element

Element id

MessageHeader.enterer

Short description

The source of the data entry

Definition

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.

Requirements

Need to know for audit/traceback requirements and possibly for authorization.

Comments

Usually only for the request but can be used in a response.

Data type

Reference(Practitioner | PractitionerRole)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
v2: EVN-5 / ORC-10 / PRT-5:PRT-4='EP' / ROL where ROL.3 is EP or ORC.10
rim: unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[typeCode="ENT" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/player[isNormalEntity() and classCode=("DEV", "PSN") and determinerCode="INST"])

author

Σ C

0..1

Reference(Practitioner | PractitionerRole)

There are no (further) constraints on this element

Element id

MessageHeader.author

Short description

The source of the decision

Definition

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.

Requirements

Need to know for audit/traceback requirements and possibly for authorization.

Comments

Usually only for the request but can be used in a response.

Data type

Reference(Practitioner | PractitionerRole)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
v2: ORC-19 / PRT-5:PRT-4='AUT' / ROL where ROL.3 is IP or ORC.12
rim: unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode="AUT" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/player[isNormalEntity() and classCode=("DEV", "PSN") and determinerCode="INST"])

source

1..1

BackboneElement

There are no (further) constraints on this element

Element id

MessageHeader.source

Short description

Message source application

Definition

The source application from which this message originated.

Requirements

Allows replies, supports audit.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.actor
rim: unique(./communicationFunction[typeCode="SND"])

0..1

string

There are no (further) constraints on this element

Element id

MessageHeader.source.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

MessageHeader.source.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

MessageHeader.source.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

name

0..1

string

There are no (further) constraints on this element

Element id

MessageHeader.source.name

Short description

Name of system

Definition

Human-readable name for the source system.

Requirements

May be used to support audit.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: MSH-3
rim: unique(./entity[determinerCode="INST" and classCode="DEV"]/name[type='ST' and isNormalDatatype()])

software

0..1

string

There are no (further) constraints on this element

Element id

MessageHeader.source.software

Short description

Name of software running the system

Definition

May include configuration or other information useful in debugging.

Requirements

Supports audit and possibly interface engine behavior.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SFT-3 ( +SFT-1)
rim: unique(./entity[determinerCode="INST" and classCode="DEV"]/softwareName[isNormalDatatype()])

version

0..1

string

There are no (further) constraints on this element

Element id

MessageHeader.source.version

Short description

Version of software running

Definition

Can convey versions of multiple systems in situations where a message passes through multiple hands.

Requirements

Supports audit and possibly interface engine behavior.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SFT-2
rim: (Not supported)

contact

Σ C

0..1

ContactPoint

There are no (further) constraints on this element

Element id

MessageHeader.source.contact

Short description

Human contact for problems

Definition

An e-mail, phone, website or other contact point to use to resolve issues with message communications.

Requirements

Allows escalation of technical issues.

Data type

ContactPoint

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
cpt-2: A system is required if a value is provided.
value.empty() or system.exists()

Mappings

rim: n/a
v2: XTN
rim: TEL
servd: ContactPoint
v2: (MSH-22?)
rim: unique(./entity[determinerCode="INST" and classCode="DEV"]/scopesRole[normalRole() and classCode="CON" and layer[classCode="PSN"]/telecom[isNormalDatatype()])

endpoint

1..1

url

There are no (further) constraints on this element

Element id

MessageHeader.source.endpoint

Short description

Actual message source address or id

Definition

Identifies the routing target to send acknowledgements to.

Requirements

Identifies where to send responses, may influence security permissions.

Comments

The id may be a non-resolvable URI for systems that do not use standard network-based addresses.

Data type

url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: MSH-24
rim: ./telecom[isNormalDatatype()]

responsible

Σ C

0..1

Reference(Organization | Practitioner | PractitionerRole)

There are no (further) constraints on this element

Element id

MessageHeader.responsible

Short description

Final responsibility for event

Definition

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.

Requirements

Need to know for audit/traceback requirements and possibly for authorization.

Comments

Usually only for the request but can be used in a response.

Data type

Reference(Organization | Practitioner | PractitionerRole)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.witness
v2: ORC-12 / PRT-5:PRT-4='OP' / PRT-8:PRT-4='OP' / ROL where ROL.3 is RO or ORC.11
rim: unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode="RESP" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/player[isNormalEntity() and classCode="PSN" and determinerCode="INST"] or ./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode="RESP" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/scoper[isNormalEntity() and classCode="ORG" and determinerCode="INST"])

reason

0..1

CodeableConcept

There are no (further) constraints on this element

Element id

MessageHeader.reason

Short description

Cause of event

Definition

Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.

Requirements

Need to be able to track why resources are being changed and report in the audit log/history of the resource. May affect authorization.

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Data type

CodeableConcept

Binding

Reason for event occurrence.

ExampleMessageReasonCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
w5: FiveWs.why[x]
v2: EVN.4 / ORC.16 / OBR-31-reason for study / BPO-13-BP indication for use / RXO-20-indication / RXE-27-give indication / RXD-21-indication / RXG-22-indication / RXA-19-indication
rim: unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/reasonCode[isNormalDatatype()])

response

Σ C

0..1

BackboneElement

Element id

MessageHeader.response

Short description

If this is a reply to prior message

Definition

Information about the message that this message is a response to. Only present if this message is a response.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, PSOM-MessageHeader-01

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: MSA
rim: ./conveyedAcknowledgement

0..1

string

There are no (further) constraints on this element

Element id

MessageHeader.response.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

MessageHeader.response.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

MessageHeader.response.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

identifier

1..1

Element id

MessageHeader.response.identifier

Short description

Id of original message

Definition

The MessageHeader.id of the message to which this message is a response.

Requirements

Allows receiver to know what message is being responded to.

Comments

This value should be the MessageHeader.id of the original message, i.e. a business identifier. See http://hl7.org/fhir/R4/messageheader-definitions.html#MessageHeader.response.identifier for more information.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: MSA-2
rim: ./acknowledges.id[isNormalDatatype()]

code

1..1

codeBinding

There are no (further) constraints on this element

Element id

MessageHeader.response.code

Short description

ok | transient-error | fatal-error

Definition

Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not.

Requirements

Allows the sender of the acknowledge message to know if the request was successful or if action is needed.

Comments

This is a generic response to the request message. Specific data for the response will be found in MessageHeader.focus.

Data type

code

Binding

The kind of response to a message.

ResponseType (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: MSA-1
rim: ./typeCode[isNormalDatatype()]

details

Σ C

0..1

Reference(OperationOutcome)

Element id

MessageHeader.response.details

Short description

Specific list of hints/warnings/errors

Definition

Full details of any issues found in the message.

Requirements

Allows the sender of the message to determine what the specific issues are.

Comments

This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error.

Data type

Reference(OperationOutcome)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, PSOM-MessageHeader-01

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: ERR
rim: AcknowledgementDetail or Observation[classCode="ALRT" and moodCode="EVN"]

focus

Σ C

0..*

Reference(DataStandardsWalesPatient | DataStandardsWalesPSOMCarePlan | DataStandardsWalesPSOMQuestionnaireResponse | DataStandardsWalesPSOMTask)

Element id

MessageHeader.focus

Short description

The actual content of the message

Definition

The actual data of the message - a reference to the root/focus class of the event.

Requirements

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.

Comments

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.

Data type

Reference(DataStandardsWalesPatient | DataStandardsWalesPSOMCarePlan | DataStandardsWalesPSOMQuestionnaireResponse | DataStandardsWalesPSOMTask)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[typeCode="SUBJ" and isNormalParticipation]/role or ./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/outboundRelationship[typeCode="SBJ" and isNormalActRelatoinship]/target)

definition

0..1

canonical(DataStandardsWalesPSOMMessageDefinition)

Element id

MessageHeader.definition

Short description

Link to the definition for this message

Definition

Permanent link to the MessageDefinition for this message.

Requirements

Allows sender to define the expected contents of the message.

Comments

see Canonical References

Data type

canonical(DataStandardsWalesPSOMMessageDefinition)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: Not directly supported.

DataStandardsWalesPSOMMessageHeader (MessageHeader)

MessageHeader

Element id

MessageHeader

Short description

A resource that describes a message that is exchanged between systems

Definition

Data type

MessageHeader

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.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-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-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
PSOM-MessageHeader-01: All exception response messages must include a fully specified response (including an OperationOutcome that contains the issue details).
event.code = 'exception-response' implies (response.details.exists())

Mappings

rim: Entity. Role, or Act
v2: MSH / MSA / ERR
rim: Message

0..1

string

There are no (further) constraints on this element

Element id

MessageHeader.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

string

Meta

There are no (further) constraints on this element

Element id

MessageHeader.meta

Short description

Metadata about the resource

Definition

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.

Data type

Meta

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..1

uri

There are no (further) constraints on this element

Element id

MessageHeader.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

MessageHeader.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

text

0..1

Narrative

There are no (further) constraints on this element

Element id

MessageHeader.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..*

Resource

There are no (further) constraints on this element

Element id

MessageHeader.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Resource

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..*

Extension

There are no (further) constraints on this element

Element id

MessageHeader.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

?! C

0..*

Extension

There are no (further) constraints on this element

Element id

MessageHeader.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

event[x]

Σ C

1..1

Binding

Element id

MessageHeader.event[x]

Short description

Code for the event this message represents or link to event definition

Definition

Requirements

Drives the behavior associated with this message.

Comments

The time of the event will be found in the focus resource. The time of the message will be found in Bundle.timestamp.

Binding

PSOM message events

DataStandardsWalesPSOMMessageEvent (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, PSOM-MessageHeader-01

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.what[x]
v2: MSH-9.2
rim: ./payload[classCode="CACT" and moodCode="EVN" and isNormalAct()]/code[isNormalDatatype()]/code

eventCoding

Coding

Data type

Coding

destination

0..*

BackboneElement

There are no (further) constraints on this element

Element id

MessageHeader.destination

Short description

Message destination application(s)

Definition

The destination application which the message is intended for.

Requirements

Indicates where message is to be sent for routing purposes. Allows verification of "am I the intended recipient".

Comments

There SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.subject[x]
rim: ./communicationFunction[typeCode="RCV"]
w5: FiveWs.subject

0..1

string

There are no (further) constraints on this element

Element id

MessageHeader.destination.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

MessageHeader.destination.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

MessageHeader.destination.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

name

0..1

string

There are no (further) constraints on this element

Element id

MessageHeader.destination.name

Short description

Name of system

Definition

Human-readable name for the target system.

Requirements

May be used for routing of response and/or to support audit.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: MSH-5
rim: unique(./entity[determinerCode="INST" and (classCode=("DEV", "PSN", "ORG"]/name[type='ST' and isNormalDatatype()])

target

Σ C

0..1

Reference(Device)

There are no (further) constraints on this element

Element id

MessageHeader.destination.target

Short description

Particular delivery destination within the destination

Definition

Identifies the target end system in situations where the initial message transmission is to an intermediary system.

Requirements

Supports multi-hop routing.

Comments

Data type

Reference(Device)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: unique(./entity[determinerCode="INST" and (classCode=("DEV", "PSN", "ORG"]

endpoint

1..1

url

There are no (further) constraints on this element

Element id

MessageHeader.destination.endpoint

Short description

Actual destination address or id

Definition

Indicates where the message should be routed to.

Requirements

Identifies where to route the message.

Comments

The id may be a non-resolvable URI for systems that do not use standard network-based addresses.

Data type

url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: MSH-25 (or MSH-6)
rim: ./telecom

receiver

Σ C

0..1

Reference(Organization | Practitioner | PractitionerRole)

There are no (further) constraints on this element

Element id

MessageHeader.destination.receiver

Short description

Intended "real-world" recipient for the data

Definition

Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.

Requirements

Allows routing beyond just the application level.

Comments

Data type

Reference(Organization | Practitioner | PractitionerRole)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.subject[x]
v2: PRT-5:PRT-4='WAYR' / PRT-8:PRT-4='WAYR'
rim: Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText
w5: FiveWs.subject

sender

Σ C

0..1

Reference(Organization | Practitioner | PractitionerRole)

There are no (further) constraints on this element

Element id

MessageHeader.sender

Short description

Real world sender of the message

Definition

Identifies the sending system to allow the use of a trust relationship.

Requirements

Allows routing beyond just the application level.

Comments

Use case is for where a (trusted) sending system is responsible for multiple organizations, and therefore cannot differentiate based on source endpoint / authentication alone.

Data type

Reference(Organization | Practitioner | PractitionerRole)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.subject[x]
v2: PRT-5:PRT-4='WAYR' / PRT-8:PRT-4='WAYR'
rim: Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText
w5: FiveWs.subject

enterer

Σ C

0..1

Reference(Practitioner | PractitionerRole)

There are no (further) constraints on this element

Element id

MessageHeader.enterer

Short description

The source of the data entry

Definition

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.

Requirements

Need to know for audit/traceback requirements and possibly for authorization.

Comments

Usually only for the request but can be used in a response.

Data type

Reference(Practitioner | PractitionerRole)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
v2: EVN-5 / ORC-10 / PRT-5:PRT-4='EP' / ROL where ROL.3 is EP or ORC.10
rim: unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[typeCode="ENT" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/player[isNormalEntity() and classCode=("DEV", "PSN") and determinerCode="INST"])

author

Σ C

0..1

Reference(Practitioner | PractitionerRole)

There are no (further) constraints on this element

Element id

MessageHeader.author

Short description

The source of the decision

Definition

Requirements

Need to know for audit/traceback requirements and possibly for authorization.

Comments

Usually only for the request but can be used in a response.

Data type

Reference(Practitioner | PractitionerRole)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
v2: ORC-19 / PRT-5:PRT-4='AUT' / ROL where ROL.3 is IP or ORC.12
rim: unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode="AUT" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/player[isNormalEntity() and classCode=("DEV", "PSN") and determinerCode="INST"])

source

1..1

BackboneElement

There are no (further) constraints on this element

Element id

MessageHeader.source

Short description

Message source application

Definition

The source application from which this message originated.

Requirements

Allows replies, supports audit.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.actor
rim: unique(./communicationFunction[typeCode="SND"])

0..1

string

There are no (further) constraints on this element

Element id

MessageHeader.source.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

MessageHeader.source.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

MessageHeader.source.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

name

0..1

string

There are no (further) constraints on this element

Element id

MessageHeader.source.name

Short description

Name of system

Definition

Human-readable name for the source system.

Requirements

May be used to support audit.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: MSH-3
rim: unique(./entity[determinerCode="INST" and classCode="DEV"]/name[type='ST' and isNormalDatatype()])

software

0..1

string

There are no (further) constraints on this element

Element id

MessageHeader.source.software

Short description

Name of software running the system

Definition

May include configuration or other information useful in debugging.

Requirements

Supports audit and possibly interface engine behavior.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SFT-3 ( +SFT-1)
rim: unique(./entity[determinerCode="INST" and classCode="DEV"]/softwareName[isNormalDatatype()])

version

0..1

string

There are no (further) constraints on this element

Element id

MessageHeader.source.version

Short description

Version of software running

Definition

Can convey versions of multiple systems in situations where a message passes through multiple hands.

Requirements

Supports audit and possibly interface engine behavior.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SFT-2
rim: (Not supported)

contact

Σ C

0..1

ContactPoint

There are no (further) constraints on this element

Element id

MessageHeader.source.contact

Short description

Human contact for problems

Definition

An e-mail, phone, website or other contact point to use to resolve issues with message communications.

Requirements

Allows escalation of technical issues.

Data type

ContactPoint

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
cpt-2: A system is required if a value is provided.
value.empty() or system.exists()

Mappings

rim: n/a
v2: XTN
rim: TEL
servd: ContactPoint
v2: (MSH-22?)
rim: unique(./entity[determinerCode="INST" and classCode="DEV"]/scopesRole[normalRole() and classCode="CON" and layer[classCode="PSN"]/telecom[isNormalDatatype()])

endpoint

1..1

url

There are no (further) constraints on this element

Element id

MessageHeader.source.endpoint

Short description

Actual message source address or id

Definition

Identifies the routing target to send acknowledgements to.

Requirements

Identifies where to send responses, may influence security permissions.

Comments

The id may be a non-resolvable URI for systems that do not use standard network-based addresses.

Data type

url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: MSH-24
rim: ./telecom[isNormalDatatype()]

responsible

Σ C

0..1

Reference(Organization | Practitioner | PractitionerRole)

There are no (further) constraints on this element

Element id

MessageHeader.responsible

Short description

Final responsibility for event

Definition

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.

Requirements

Need to know for audit/traceback requirements and possibly for authorization.

Comments

Usually only for the request but can be used in a response.

Data type

Reference(Organization | Practitioner | PractitionerRole)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.witness
v2: ORC-12 / PRT-5:PRT-4='OP' / PRT-8:PRT-4='OP' / ROL where ROL.3 is RO or ORC.11
rim: unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode="RESP" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/player[isNormalEntity() and classCode="PSN" and determinerCode="INST"] or ./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode="RESP" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/scoper[isNormalEntity() and classCode="ORG" and determinerCode="INST"])

reason

0..1

CodeableConcept

There are no (further) constraints on this element

Element id

MessageHeader.reason

Short description

Cause of event

Definition

Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.

Requirements

Need to be able to track why resources are being changed and report in the audit log/history of the resource. May affect authorization.

Comments

Data type

CodeableConcept

Binding

Reason for event occurrence.

ExampleMessageReasonCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
w5: FiveWs.why[x]
v2: EVN.4 / ORC.16 / OBR-31-reason for study / BPO-13-BP indication for use / RXO-20-indication / RXE-27-give indication / RXD-21-indication / RXG-22-indication / RXA-19-indication
rim: unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/reasonCode[isNormalDatatype()])

response

Σ C

0..1

BackboneElement

Element id

MessageHeader.response

Short description

If this is a reply to prior message

Definition

Information about the message that this message is a response to. Only present if this message is a response.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, PSOM-MessageHeader-01

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: MSA
rim: ./conveyedAcknowledgement

0..1

string

There are no (further) constraints on this element

Element id

MessageHeader.response.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

MessageHeader.response.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

MessageHeader.response.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

identifier

1..1

Element id

MessageHeader.response.identifier

Short description

Id of original message

Definition

The MessageHeader.id of the message to which this message is a response.

Requirements

Allows receiver to know what message is being responded to.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: MSA-2
rim: ./acknowledges.id[isNormalDatatype()]

code

1..1

codeBinding

There are no (further) constraints on this element

Element id

MessageHeader.response.code

Short description

ok | transient-error | fatal-error

Definition

Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not.

Requirements

Allows the sender of the acknowledge message to know if the request was successful or if action is needed.

Comments

This is a generic response to the request message. Specific data for the response will be found in MessageHeader.focus.

Data type

code

Binding

The kind of response to a message.

ResponseType (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: MSA-1
rim: ./typeCode[isNormalDatatype()]

details

Σ C

0..1

Reference(OperationOutcome)

Element id

MessageHeader.response.details

Short description

Specific list of hints/warnings/errors

Definition

Full details of any issues found in the message.

Requirements

Allows the sender of the message to determine what the specific issues are.

Comments

This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error.

Data type

Reference(OperationOutcome)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, PSOM-MessageHeader-01

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: ERR
rim: AcknowledgementDetail or Observation[classCode="ALRT" and moodCode="EVN"]

focus

Σ C

0..*

Reference(DataStandardsWalesPatient | DataStandardsWalesPSOMCarePlan | DataStandardsWalesPSOMQuestionnaireResponse | DataStandardsWalesPSOMTask)

Element id

MessageHeader.focus

Short description

The actual content of the message

Definition

The actual data of the message - a reference to the root/focus class of the event.

Requirements

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.

Comments

Data type

Reference(DataStandardsWalesPatient | DataStandardsWalesPSOMCarePlan | DataStandardsWalesPSOMQuestionnaireResponse | DataStandardsWalesPSOMTask)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[typeCode="SUBJ" and isNormalParticipation]/role or ./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/outboundRelationship[typeCode="SBJ" and isNormalActRelatoinship]/target)

definition

0..1

canonical(DataStandardsWalesPSOMMessageDefinition)

Element id

MessageHeader.definition

Short description

Link to the definition for this message

Definition

Permanent link to the MessageDefinition for this message.

Requirements

Allows sender to define the expected contents of the message.

Comments

see Canonical References

Data type

canonical(DataStandardsWalesPSOMMessageDefinition)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: Not directly supported.

DataStandardsWalesPSOMMessageHeader (MessageHeader)

MessageHeader

Element id

MessageHeader

Short description

A resource that describes a message that is exchanged between systems

Definition

Data type

MessageHeader

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.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-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-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
PSOM-MessageHeader-01: All exception response messages must include a fully specified response (including an OperationOutcome that contains the issue details).
event.code = 'exception-response' implies (response.details.exists())

Mappings

rim: Entity. Role, or Act
v2: MSH / MSA / ERR
rim: Message

0..1

string

There are no (further) constraints on this element

Element id

MessageHeader.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

string

Meta

There are no (further) constraints on this element

Element id

MessageHeader.meta

Short description

Metadata about the resource

Definition

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.

Data type

Meta

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..1

uri

There are no (further) constraints on this element

Element id

MessageHeader.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

MessageHeader.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

text

0..1

Narrative

There are no (further) constraints on this element

Element id

MessageHeader.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..*

Resource

There are no (further) constraints on this element

Element id

MessageHeader.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Resource

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..*

Extension

There are no (further) constraints on this element

Element id

MessageHeader.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

?! C

0..*

Extension

There are no (further) constraints on this element

Element id

MessageHeader.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

event[x]

Σ C

1..1

Binding

Element id

MessageHeader.event[x]

Short description

Code for the event this message represents or link to event definition

Definition

Requirements

Drives the behavior associated with this message.

Comments

The time of the event will be found in the focus resource. The time of the message will be found in Bundle.timestamp.

Binding

PSOM message events

DataStandardsWalesPSOMMessageEvent (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, PSOM-MessageHeader-01

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.what[x]
v2: MSH-9.2
rim: ./payload[classCode="CACT" and moodCode="EVN" and isNormalAct()]/code[isNormalDatatype()]/code

eventCoding

Coding

Data type

Coding

destination

0..*

BackboneElement

There are no (further) constraints on this element

Element id

MessageHeader.destination

Short description

Message destination application(s)

Definition

The destination application which the message is intended for.

Requirements

Indicates where message is to be sent for routing purposes. Allows verification of "am I the intended recipient".

Comments

There SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.subject[x]
rim: ./communicationFunction[typeCode="RCV"]
w5: FiveWs.subject

0..1

string

There are no (further) constraints on this element

Element id

MessageHeader.destination.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

MessageHeader.destination.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

MessageHeader.destination.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

name

0..1

string

There are no (further) constraints on this element

Element id

MessageHeader.destination.name

Short description

Name of system

Definition

Human-readable name for the target system.

Requirements

May be used for routing of response and/or to support audit.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: MSH-5
rim: unique(./entity[determinerCode="INST" and (classCode=("DEV", "PSN", "ORG"]/name[type='ST' and isNormalDatatype()])

target

Σ C

0..1

Reference(Device)

There are no (further) constraints on this element

Element id

MessageHeader.destination.target

Short description

Particular delivery destination within the destination

Definition

Identifies the target end system in situations where the initial message transmission is to an intermediary system.

Requirements

Supports multi-hop routing.

Comments

Data type

Reference(Device)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: unique(./entity[determinerCode="INST" and (classCode=("DEV", "PSN", "ORG"]

endpoint

1..1

url

There are no (further) constraints on this element

Element id

MessageHeader.destination.endpoint

Short description

Actual destination address or id

Definition

Indicates where the message should be routed to.

Requirements

Identifies where to route the message.

Comments

The id may be a non-resolvable URI for systems that do not use standard network-based addresses.

Data type

url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: MSH-25 (or MSH-6)
rim: ./telecom

receiver

Σ C

0..1

Reference(Organization | Practitioner | PractitionerRole)

There are no (further) constraints on this element

Element id

MessageHeader.destination.receiver

Short description

Intended "real-world" recipient for the data

Definition

Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.

Requirements

Allows routing beyond just the application level.

Comments

Data type

Reference(Organization | Practitioner | PractitionerRole)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.subject[x]
v2: PRT-5:PRT-4='WAYR' / PRT-8:PRT-4='WAYR'
rim: Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText
w5: FiveWs.subject

sender

Σ C

0..1

Reference(Organization | Practitioner | PractitionerRole)

There are no (further) constraints on this element

Element id

MessageHeader.sender

Short description

Real world sender of the message

Definition

Identifies the sending system to allow the use of a trust relationship.

Requirements

Allows routing beyond just the application level.

Comments

Use case is for where a (trusted) sending system is responsible for multiple organizations, and therefore cannot differentiate based on source endpoint / authentication alone.

Data type

Reference(Organization | Practitioner | PractitionerRole)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.subject[x]
v2: PRT-5:PRT-4='WAYR' / PRT-8:PRT-4='WAYR'
rim: Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText
w5: FiveWs.subject

enterer

Σ C

0..1

Reference(Practitioner | PractitionerRole)

There are no (further) constraints on this element

Element id

MessageHeader.enterer

Short description

The source of the data entry

Definition

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.

Requirements

Need to know for audit/traceback requirements and possibly for authorization.

Comments

Usually only for the request but can be used in a response.

Data type

Reference(Practitioner | PractitionerRole)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
v2: EVN-5 / ORC-10 / PRT-5:PRT-4='EP' / ROL where ROL.3 is EP or ORC.10
rim: unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[typeCode="ENT" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/player[isNormalEntity() and classCode=("DEV", "PSN") and determinerCode="INST"])

author

Σ C

0..1

Reference(Practitioner | PractitionerRole)

There are no (further) constraints on this element

Element id

MessageHeader.author

Short description

The source of the decision

Definition

Requirements

Need to know for audit/traceback requirements and possibly for authorization.

Comments

Usually only for the request but can be used in a response.

Data type

Reference(Practitioner | PractitionerRole)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.author
v2: ORC-19 / PRT-5:PRT-4='AUT' / ROL where ROL.3 is IP or ORC.12
rim: unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode="AUT" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/player[isNormalEntity() and classCode=("DEV", "PSN") and determinerCode="INST"])

source

1..1

BackboneElement

There are no (further) constraints on this element

Element id

MessageHeader.source

Short description

Message source application

Definition

The source application from which this message originated.

Requirements

Allows replies, supports audit.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.actor
rim: unique(./communicationFunction[typeCode="SND"])

0..1

string

There are no (further) constraints on this element

Element id

MessageHeader.source.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

MessageHeader.source.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

MessageHeader.source.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

name

0..1

string

There are no (further) constraints on this element

Element id

MessageHeader.source.name

Short description

Name of system

Definition

Human-readable name for the source system.

Requirements

May be used to support audit.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: MSH-3
rim: unique(./entity[determinerCode="INST" and classCode="DEV"]/name[type='ST' and isNormalDatatype()])

software

0..1

string

There are no (further) constraints on this element

Element id

MessageHeader.source.software

Short description

Name of software running the system

Definition

May include configuration or other information useful in debugging.

Requirements

Supports audit and possibly interface engine behavior.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SFT-3 ( +SFT-1)
rim: unique(./entity[determinerCode="INST" and classCode="DEV"]/softwareName[isNormalDatatype()])

version

0..1

string

There are no (further) constraints on this element

Element id

MessageHeader.source.version

Short description

Version of software running

Definition

Can convey versions of multiple systems in situations where a message passes through multiple hands.

Requirements

Supports audit and possibly interface engine behavior.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SFT-2
rim: (Not supported)

contact

Σ C

0..1

ContactPoint

There are no (further) constraints on this element

Element id

MessageHeader.source.contact

Short description

Human contact for problems

Definition

An e-mail, phone, website or other contact point to use to resolve issues with message communications.

Requirements

Allows escalation of technical issues.

Data type

ContactPoint

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
cpt-2: A system is required if a value is provided.
value.empty() or system.exists()

Mappings

rim: n/a
v2: XTN
rim: TEL
servd: ContactPoint
v2: (MSH-22?)
rim: unique(./entity[determinerCode="INST" and classCode="DEV"]/scopesRole[normalRole() and classCode="CON" and layer[classCode="PSN"]/telecom[isNormalDatatype()])

endpoint

1..1

url

There are no (further) constraints on this element

Element id

MessageHeader.source.endpoint

Short description

Actual message source address or id

Definition

Identifies the routing target to send acknowledgements to.

Requirements

Identifies where to send responses, may influence security permissions.

Comments

The id may be a non-resolvable URI for systems that do not use standard network-based addresses.

Data type

url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: MSH-24
rim: ./telecom[isNormalDatatype()]

responsible

Σ C

0..1

Reference(Organization | Practitioner | PractitionerRole)

There are no (further) constraints on this element

Element id

MessageHeader.responsible

Short description

Final responsibility for event

Definition

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.

Requirements

Need to know for audit/traceback requirements and possibly for authorization.

Comments

Usually only for the request but can be used in a response.

Data type

Reference(Organization | Practitioner | PractitionerRole)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.witness
v2: ORC-12 / PRT-5:PRT-4='OP' / PRT-8:PRT-4='OP' / ROL where ROL.3 is RO or ORC.11
rim: unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode="RESP" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/player[isNormalEntity() and classCode="PSN" and determinerCode="INST"] or ./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode="RESP" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/scoper[isNormalEntity() and classCode="ORG" and determinerCode="INST"])

reason

0..1

CodeableConcept

There are no (further) constraints on this element

Element id

MessageHeader.reason

Short description

Cause of event

Definition

Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.

Requirements

Need to be able to track why resources are being changed and report in the audit log/history of the resource. May affect authorization.

Comments

Data type

CodeableConcept

Binding

Reason for event occurrence.

ExampleMessageReasonCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
w5: FiveWs.why[x]
v2: EVN.4 / ORC.16 / OBR-31-reason for study / BPO-13-BP indication for use / RXO-20-indication / RXE-27-give indication / RXD-21-indication / RXG-22-indication / RXA-19-indication
rim: unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/reasonCode[isNormalDatatype()])

response

Σ C

0..1

BackboneElement

Element id

MessageHeader.response

Short description

If this is a reply to prior message

Definition

Information about the message that this message is a response to. Only present if this message is a response.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, PSOM-MessageHeader-01

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: MSA
rim: ./conveyedAcknowledgement

0..1

string

There are no (further) constraints on this element

Element id

MessageHeader.response.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

MessageHeader.response.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

MessageHeader.response.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

identifier

1..1

Element id

MessageHeader.response.identifier

Short description

Id of original message

Definition

The MessageHeader.id of the message to which this message is a response.

Requirements

Allows receiver to know what message is being responded to.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: MSA-2
rim: ./acknowledges.id[isNormalDatatype()]

code

1..1

codeBinding

There are no (further) constraints on this element

Element id

MessageHeader.response.code

Short description

ok | transient-error | fatal-error

Definition

Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not.

Requirements

Allows the sender of the acknowledge message to know if the request was successful or if action is needed.

Comments

This is a generic response to the request message. Specific data for the response will be found in MessageHeader.focus.

Data type

code

Binding

The kind of response to a message.

ResponseType (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: MSA-1
rim: ./typeCode[isNormalDatatype()]

details

Σ C

0..1

Reference(OperationOutcome)

Element id

MessageHeader.response.details

Short description

Specific list of hints/warnings/errors

Definition

Full details of any issues found in the message.

Requirements

Allows the sender of the message to determine what the specific issues are.

Comments

This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error.

Data type

Reference(OperationOutcome)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, PSOM-MessageHeader-01

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: ERR
rim: AcknowledgementDetail or Observation[classCode="ALRT" and moodCode="EVN"]

focus

Σ C

0..*

Reference(DataStandardsWalesPatient | DataStandardsWalesPSOMCarePlan | DataStandardsWalesPSOMQuestionnaireResponse | DataStandardsWalesPSOMTask)

Element id

MessageHeader.focus

Short description

The actual content of the message

Definition

The actual data of the message - a reference to the root/focus class of the event.

Requirements

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.

Comments

Data type

Reference(DataStandardsWalesPatient | DataStandardsWalesPSOMCarePlan | DataStandardsWalesPSOMQuestionnaireResponse | DataStandardsWalesPSOMTask)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[typeCode="SUBJ" and isNormalParticipation]/role or ./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/outboundRelationship[typeCode="SBJ" and isNormalActRelatoinship]/target)

definition

0..1

canonical(DataStandardsWalesPSOMMessageDefinition)

Element id