FHIR Data Standards Wales for PSOM v1.0.0-rc1

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

DataStandardsWales-PSOM-MessageDefinition

Profile	Description	Status	Purpose	URL
Data Standards Wales PSOM MessageDefinition	A profile that defines the characteristics of a PSOM message that can be shared between systems, including the type of event that initiates the message. Instances of this resource provide information on the content to be transmitted and what response(s), if any, are permitted.	draft	This profile defines the base MessageDefinition structure for PSOM messages. Inspiration is taken from the NHSDigital-MessageDefinition profile (url = https://fhir.nhs.uk/StructureDefinition/NHSDigital-MessageDefinition).	https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-PSOM-MessageDefinition

Formal Views of Profile Content

Snapshot View
Differential View
Hybrid View
Mappings

MessageDefinition	I		MessageDefinition	There are no (further) constraints on this element Element Id MessageDefinition Short description A resource that defines a type of message that can be exchanged between systems Definition Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted. Comments This would be a MIF-level artifact. Data Type MessageDefinition 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()` msd-0:Name should be usable as an identifier for the module by machine processing applications such as code generation `name.matches('[A-Z]([A-Za-z0-9_]){0,254}')` Mappings rim:Entity. Role, or Act v2:N/A rim:N/A
url	Σ I	1..1	uri	Element Id MessageDefinition.url Short description Business Identifier for a given MessageDefinition Definition The business identifier that is used to reference the MessageDefinition and is expected to be consistent from server to server. Requirements Allows the message definition to be referenced by a single globally unique identifier. Comments Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` -MessageDefinition-01:The MessageDefinition.url needs to start with the NHS Wales base. `startsWith('https://fhir.nhs.wales/MessageDefinition/')` Mappings rim:n/a workflow:Definition.url w5:FiveWs.identifier
identifier	Σ	0..*	Identifier	There are no (further) constraints on this element Element Id MessageDefinition.identifier Short description Primary key for the message definition on a given server Definition A formal identifier that is used to identify this message definition when it is represented in other formats, or referenced in a specification, model, design or an instance. Requirements Allows externally provided and/or usable business identifiers to be easily associated with the module. Comments Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this message definition outside of FHIR, where it is not possible to use the logical URI. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier workflow:Definition.identifier w5:FiveWs.identifier objimpl:no-gen-base
version	Σ	0..1	string	There are no (further) constraints on this element Element Id MessageDefinition.version Short description Business version of the message definition Definition The identifier that is used to identify this version of the message definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the message definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. Comments There may be different message definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the message definition with the format [url]\|[version]. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.version w5:FiveWs.version
name	Σ I	0..1	string	There are no (further) constraints on this element Element Id MessageDefinition.name Short description Name for this message definition (computer friendly) Definition A natural language name identifying the message definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. Requirements Support human navigation and code generation. Comments The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
title	Σ	0..1	string	There are no (further) constraints on this element Element Id MessageDefinition.title Short description Name for this message definition (human friendly) Definition A short, descriptive, user-friendly title for the message definition. Comments This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.title
replaces	Σ	0..*	canonical(MessageDefinition)	There are no (further) constraints on this element Element Id MessageDefinition.replaces Short description Takes the place of Definition A MessageDefinition that is superseded by this definition. Comments see Canonical References Data Type canonical(MessageDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
status	Σ ?!	1..1	codeBinding	There are no (further) constraints on this element Element Id MessageDefinition.status Short description draft \| active \| retired \| unknown Definition The status of this message definition. Enables tracking the life-cycle of the content. Comments Allows filtering of message definitions that are appropriate for use versus not. Data Type code Binding The lifecycle status of an artifact. PublicationStatus (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.status w5:FiveWs.status
experimental	Σ	0..1	boolean	There are no (further) constraints on this element Element Id MessageDefinition.experimental Short description For testing purposes, not real usage Definition A Boolean value to indicate that this message definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Requirements Enables experimental content to be developed following the same lifecycle that would be used for a production-level message definition. Comments Allows filtering of message definitions that are appropriate for use versus not. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.experimental w5:FiveWs.class
date	Σ	1..1	dateTime	There are no (further) constraints on this element Element Id MessageDefinition.date Short description Date last changed Alternate names Revision Date Definition The date (and optionally time) when the message definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the message definition changes. Comments Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the message definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. Data Type dateTime Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.date w5:FiveWs.recorded
publisher	Σ	0..1	string	There are no (further) constraints on this element Element Id MessageDefinition.publisher Short description Name of the publisher (organization or individual) Definition The name of the organization or individual that published the message definition. Requirements Helps establish the "authority/credibility" of the message definition. May also allow for contact. Comments Usually an organization but may be an individual. The publisher (or steward) of the message definition is the organization or individual primarily responsible for the maintenance and upkeep of the message definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the message definition. This item SHOULD be populated unless the information is available from context. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.publisher w5:FiveWs.witness
contact	Σ	0..*	ContactDetail	There are no (further) constraints on this element Element Id MessageDefinition.contact Short description Contact details for the publisher Definition Contact details to assist a user in finding and communicating with the publisher. Comments May be a web site, an email address, a telephone number, etc. Data Type ContactDetail Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.contact
description	Σ	1..1	markdown	There are no (further) constraints on this element Element Id MessageDefinition.description Short description Natural language description of the message definition Definition A free text natural language description of the message definition from a consumer's perspective. Comments This description can be used to capture details such as why the message definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the message definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the message definition is presumed to be the predominant language in the place the message definition was created). Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.description
useContext	Σ	0..*	UsageContext	There are no (further) constraints on this element Element Id MessageDefinition.useContext Short description The context that the content is intended to support Definition The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate message definition instances. Requirements Assist in searching for appropriate content. Comments When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. Data Type UsageContext Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.useContext
jurisdiction	Σ	0..*	CodeableConceptBinding	There are no (further) constraints on this element Element Id MessageDefinition.jurisdiction Short description Intended jurisdiction for message definition (if applicable) Definition A legal or geographic region in which the message definition is intended to be used. Comments It may be possible for the message definition to be used in jurisdictions other than those for which it was originally designed or intended. Data Type CodeableConcept Binding Countries and regions within which this artifact is targeted for use. Jurisdiction ValueSet (extensible) 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 workflow:Definition.jurisdiction
purpose	Σ	0..1	markdown	There are no (further) constraints on this element Element Id MessageDefinition.purpose Short description Why this message definition is defined Definition Explanation of why this message definition is needed and why it has been designed as it has. Comments This element does not describe the usage of the message definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this message definition. Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.purpose w5:FiveWs.why[x] objimpl:no-gen-base
copyright		0..1	markdown	There are no (further) constraints on this element Element Id MessageDefinition.copyright Short description Use and/or publishing restrictions Alternate names License, Restrictions Definition A copyright statement relating to the message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message definition. Requirements Consumers must be able to determine any legal restrictions on the use of the message definition and/or its content. Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.copyright objimpl:no-gen-base
base	Σ	0..1	canonical(MessageDefinition)	There are no (further) constraints on this element Element Id MessageDefinition.base Short description Definition this one is based on Definition The MessageDefinition that is the basis for the contents of this resource. Comments see Canonical References Data Type canonical(MessageDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
parent	Σ	0..*	canonical(ActivityDefinition \| PlanDefinition)	There are no (further) constraints on this element Element Id MessageDefinition.parent Short description Protocol/workflow this is part of Definition Identifies a protocol or workflow that this MessageDefinition represents a step in. Comments It should be possible to use MessageDefinition to describe a message to be used by certain steps in a particular protocol as part of a PlanDefinition or ActivityDefinition. Data Type canonical(ActivityDefinition \| PlanDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
event[x]	Σ	1..1	Binding	Element Id MessageDefinition.event[x] Short description Event code or link to the EventDefinition Definition Event code or link to the EventDefinition. Binding NHS Wales Message Events DataStandardsWalesPSOMMessageEvent (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
eventCoding			Coding	Data Type Coding
category	Σ	0..1	codeBinding	There are no (further) constraints on this element Element Id MessageDefinition.category Short description consequence \| currency \| notification Definition The impact of the content of the message. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding The impact of the content of a message. MessageSignificanceCategory (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
focus	Σ I	1..*	BackboneElement	There are no (further) constraints on this element Element Id MessageDefinition.focus Short description Resource(s) that are the subject of the event Definition Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` md-1:Max must be postive int or * `max='' or (max.toInteger() > 0)` Mappings* rim:n/a
code	Σ	1..1	codeBinding	There are no (further) constraints on this element Element Id MessageDefinition.focus.code Short description Type of resource Definition The kind of resource that must be the focus for this message. Comments Multiple focuses addressing different resources may occasionally occur. E.g. to link or unlink a resource from a particular account or encounter, etc. Data Type code Binding One of the resource types defined as part of this version of FHIR. ResourceType (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
profile		0..1	canonical(StructureDefinition)	There are no (further) constraints on this element Element Id MessageDefinition.focus.profile Short description Profile that must be adhered to by focus Definition A profile that reflects constraints for the focal resource (and potentially for related resources). Requirements This profile allows setting boundaries for what content must appear within the message bundle vs. outside based on the declared aggregation constraints on referenced resources on this and related profiles. Comments This should be present for most message definitions. However, if the message focus is only a single resource and there is no need to include referenced resources or otherwise enforce the presence of particular elements, it can be omitted. Data Type canonical(StructureDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
min	Σ	1..1	unsignedInt	There are no (further) constraints on this element Element Id MessageDefinition.focus.min Short description Minimum number of focuses of this type Definition Identifies the minimum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition. Comments 32 bit number; for values larger than this, use decimal Data Type unsignedInt Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
max	I	0..1	string	There are no (further) constraints on this element Element Id MessageDefinition.focus.max Short description Maximum number of focuses of this type Definition Identifies the maximum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
responseRequired		0..1	codeBinding	There are no (further) constraints on this element Element Id MessageDefinition.responseRequired Short description always \| on-error \| never \| on-success Definition Declare at a message definition level whether a response is required or only upon error or success, or never. Comments This enables the capability currently available through MSH-16 (Application Level acknowledgement) in HL7 Version 2 to declare at a message instance level whether a response is required or only upon error or success, or never. Data Type code Binding HL7-defined table of codes which identify conditions under which acknowledgments are required to be returned in response to a message. messageheader-response-request (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General always Mappings rim:n/a v2:MSH-16
allowedResponse		0..*	BackboneElement	There are no (further) constraints on this element Element Id MessageDefinition.allowedResponse Short description Responses to this message Definition Indicates what types of messages may be sent as an application-level response to this message. Comments This indicates an application level response to "close" a transaction implicit in a particular request message. To define a complete workflow scenario, look to the [[PlanDefinition]] resource which allows the definition of complex orchestrations, conditionality, etc. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
message		1..1	canonical(MessageDefinition)	There are no (further) constraints on this element Element Id MessageDefinition.allowedResponse.message Short description Reference to allowed message definition response Definition A reference to the message definition that must be adhered to by this supported response. Comments see Canonical References Data Type canonical(MessageDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
situation		0..1	markdown	There are no (further) constraints on this element Element Id MessageDefinition.allowedResponse.situation Short description When should this response be used Definition Provides a description of the circumstances in which this response should be used (as opposed to one of the alternative responses). Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
graph		0..*	canonical(GraphDefinition)	There are no (further) constraints on this element Element Id MessageDefinition.graph Short description Canonical reference to a GraphDefinition Definition Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a GraphDefinition that it controls what resources are to be added to the bundle when building the document. The GraphDefinition can also specify profiles that apply to the various resources. Comments see Canonical References Data Type canonical(GraphDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a

MessageDefinition	I		MessageDefinition	There are no (further) constraints on this element Element Id MessageDefinition Short description A resource that defines a type of message that can be exchanged between systems Definition Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted. Comments This would be a MIF-level artifact. Data Type MessageDefinition 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()` msd-0:Name should be usable as an identifier for the module by machine processing applications such as code generation `name.matches('[A-Z]([A-Za-z0-9_]){0,254}')` Mappings rim:Entity. Role, or Act v2:N/A rim:N/A
url	Σ I	1..1	uri	Element Id MessageDefinition.url Short description Business Identifier for a given MessageDefinition Definition The business identifier that is used to reference the MessageDefinition and is expected to be consistent from server to server. Requirements Allows the message definition to be referenced by a single globally unique identifier. Comments Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` -MessageDefinition-01:The MessageDefinition.url needs to start with the NHS Wales base. `startsWith('https://fhir.nhs.wales/MessageDefinition/')` Mappings rim:n/a workflow:Definition.url w5:FiveWs.identifier
identifier	Σ	0..*	Identifier	There are no (further) constraints on this element Element Id MessageDefinition.identifier Short description Primary key for the message definition on a given server Definition A formal identifier that is used to identify this message definition when it is represented in other formats, or referenced in a specification, model, design or an instance. Requirements Allows externally provided and/or usable business identifiers to be easily associated with the module. Comments Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this message definition outside of FHIR, where it is not possible to use the logical URI. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier workflow:Definition.identifier w5:FiveWs.identifier objimpl:no-gen-base
version	Σ	0..1	string	There are no (further) constraints on this element Element Id MessageDefinition.version Short description Business version of the message definition Definition The identifier that is used to identify this version of the message definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the message definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. Comments There may be different message definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the message definition with the format [url]\|[version]. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.version w5:FiveWs.version
name	Σ I	0..1	string	There are no (further) constraints on this element Element Id MessageDefinition.name Short description Name for this message definition (computer friendly) Definition A natural language name identifying the message definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. Requirements Support human navigation and code generation. Comments The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
title	Σ	0..1	string	There are no (further) constraints on this element Element Id MessageDefinition.title Short description Name for this message definition (human friendly) Definition A short, descriptive, user-friendly title for the message definition. Comments This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.title
replaces	Σ	0..*	canonical(MessageDefinition)	There are no (further) constraints on this element Element Id MessageDefinition.replaces Short description Takes the place of Definition A MessageDefinition that is superseded by this definition. Comments see Canonical References Data Type canonical(MessageDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
status	Σ ?!	1..1	codeBinding	There are no (further) constraints on this element Element Id MessageDefinition.status Short description draft \| active \| retired \| unknown Definition The status of this message definition. Enables tracking the life-cycle of the content. Comments Allows filtering of message definitions that are appropriate for use versus not. Data Type code Binding The lifecycle status of an artifact. PublicationStatus (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.status w5:FiveWs.status
experimental	Σ	0..1	boolean	There are no (further) constraints on this element Element Id MessageDefinition.experimental Short description For testing purposes, not real usage Definition A Boolean value to indicate that this message definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Requirements Enables experimental content to be developed following the same lifecycle that would be used for a production-level message definition. Comments Allows filtering of message definitions that are appropriate for use versus not. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.experimental w5:FiveWs.class
date	Σ	1..1	dateTime	There are no (further) constraints on this element Element Id MessageDefinition.date Short description Date last changed Alternate names Revision Date Definition The date (and optionally time) when the message definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the message definition changes. Comments Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the message definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. Data Type dateTime Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.date w5:FiveWs.recorded
publisher	Σ	0..1	string	There are no (further) constraints on this element Element Id MessageDefinition.publisher Short description Name of the publisher (organization or individual) Definition The name of the organization or individual that published the message definition. Requirements Helps establish the "authority/credibility" of the message definition. May also allow for contact. Comments Usually an organization but may be an individual. The publisher (or steward) of the message definition is the organization or individual primarily responsible for the maintenance and upkeep of the message definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the message definition. This item SHOULD be populated unless the information is available from context. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.publisher w5:FiveWs.witness
contact	Σ	0..*	ContactDetail	There are no (further) constraints on this element Element Id MessageDefinition.contact Short description Contact details for the publisher Definition Contact details to assist a user in finding and communicating with the publisher. Comments May be a web site, an email address, a telephone number, etc. Data Type ContactDetail Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.contact
description	Σ	1..1	markdown	There are no (further) constraints on this element Element Id MessageDefinition.description Short description Natural language description of the message definition Definition A free text natural language description of the message definition from a consumer's perspective. Comments This description can be used to capture details such as why the message definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the message definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the message definition is presumed to be the predominant language in the place the message definition was created). Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.description
useContext	Σ	0..*	UsageContext	There are no (further) constraints on this element Element Id MessageDefinition.useContext Short description The context that the content is intended to support Definition The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate message definition instances. Requirements Assist in searching for appropriate content. Comments When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. Data Type UsageContext Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.useContext
jurisdiction	Σ	0..*	CodeableConceptBinding	There are no (further) constraints on this element Element Id MessageDefinition.jurisdiction Short description Intended jurisdiction for message definition (if applicable) Definition A legal or geographic region in which the message definition is intended to be used. Comments It may be possible for the message definition to be used in jurisdictions other than those for which it was originally designed or intended. Data Type CodeableConcept Binding Countries and regions within which this artifact is targeted for use. Jurisdiction ValueSet (extensible) 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 workflow:Definition.jurisdiction
purpose	Σ	0..1	markdown	There are no (further) constraints on this element Element Id MessageDefinition.purpose Short description Why this message definition is defined Definition Explanation of why this message definition is needed and why it has been designed as it has. Comments This element does not describe the usage of the message definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this message definition. Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.purpose w5:FiveWs.why[x] objimpl:no-gen-base
copyright		0..1	markdown	There are no (further) constraints on this element Element Id MessageDefinition.copyright Short description Use and/or publishing restrictions Alternate names License, Restrictions Definition A copyright statement relating to the message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message definition. Requirements Consumers must be able to determine any legal restrictions on the use of the message definition and/or its content. Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.copyright objimpl:no-gen-base
base	Σ	0..1	canonical(MessageDefinition)	There are no (further) constraints on this element Element Id MessageDefinition.base Short description Definition this one is based on Definition The MessageDefinition that is the basis for the contents of this resource. Comments see Canonical References Data Type canonical(MessageDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
parent	Σ	0..*	canonical(ActivityDefinition \| PlanDefinition)	There are no (further) constraints on this element Element Id MessageDefinition.parent Short description Protocol/workflow this is part of Definition Identifies a protocol or workflow that this MessageDefinition represents a step in. Comments It should be possible to use MessageDefinition to describe a message to be used by certain steps in a particular protocol as part of a PlanDefinition or ActivityDefinition. Data Type canonical(ActivityDefinition \| PlanDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
event[x]	Σ	1..1	Binding	Element Id MessageDefinition.event[x] Short description Event code or link to the EventDefinition Definition Event code or link to the EventDefinition. Binding NHS Wales Message Events DataStandardsWalesPSOMMessageEvent (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
eventCoding			Coding	Data Type Coding
category	Σ	0..1	codeBinding	There are no (further) constraints on this element Element Id MessageDefinition.category Short description consequence \| currency \| notification Definition The impact of the content of the message. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding The impact of the content of a message. MessageSignificanceCategory (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
focus	Σ I	1..*	BackboneElement	There are no (further) constraints on this element Element Id MessageDefinition.focus Short description Resource(s) that are the subject of the event Definition Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` md-1:Max must be postive int or * `max='' or (max.toInteger() > 0)` Mappings* rim:n/a
code	Σ	1..1	codeBinding	There are no (further) constraints on this element Element Id MessageDefinition.focus.code Short description Type of resource Definition The kind of resource that must be the focus for this message. Comments Multiple focuses addressing different resources may occasionally occur. E.g. to link or unlink a resource from a particular account or encounter, etc. Data Type code Binding One of the resource types defined as part of this version of FHIR. ResourceType (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
profile		0..1	canonical(StructureDefinition)	There are no (further) constraints on this element Element Id MessageDefinition.focus.profile Short description Profile that must be adhered to by focus Definition A profile that reflects constraints for the focal resource (and potentially for related resources). Requirements This profile allows setting boundaries for what content must appear within the message bundle vs. outside based on the declared aggregation constraints on referenced resources on this and related profiles. Comments This should be present for most message definitions. However, if the message focus is only a single resource and there is no need to include referenced resources or otherwise enforce the presence of particular elements, it can be omitted. Data Type canonical(StructureDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
min	Σ	1..1	unsignedInt	There are no (further) constraints on this element Element Id MessageDefinition.focus.min Short description Minimum number of focuses of this type Definition Identifies the minimum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition. Comments 32 bit number; for values larger than this, use decimal Data Type unsignedInt Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
max	I	0..1	string	There are no (further) constraints on this element Element Id MessageDefinition.focus.max Short description Maximum number of focuses of this type Definition Identifies the maximum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
responseRequired		0..1	codeBinding	There are no (further) constraints on this element Element Id MessageDefinition.responseRequired Short description always \| on-error \| never \| on-success Definition Declare at a message definition level whether a response is required or only upon error or success, or never. Comments This enables the capability currently available through MSH-16 (Application Level acknowledgement) in HL7 Version 2 to declare at a message instance level whether a response is required or only upon error or success, or never. Data Type code Binding HL7-defined table of codes which identify conditions under which acknowledgments are required to be returned in response to a message. messageheader-response-request (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General always Mappings rim:n/a v2:MSH-16
allowedResponse		0..*	BackboneElement	There are no (further) constraints on this element Element Id MessageDefinition.allowedResponse Short description Responses to this message Definition Indicates what types of messages may be sent as an application-level response to this message. Comments This indicates an application level response to "close" a transaction implicit in a particular request message. To define a complete workflow scenario, look to the [[PlanDefinition]] resource which allows the definition of complex orchestrations, conditionality, etc. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
message		1..1	canonical(MessageDefinition)	There are no (further) constraints on this element Element Id MessageDefinition.allowedResponse.message Short description Reference to allowed message definition response Definition A reference to the message definition that must be adhered to by this supported response. Comments see Canonical References Data Type canonical(MessageDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
situation		0..1	markdown	There are no (further) constraints on this element Element Id MessageDefinition.allowedResponse.situation Short description When should this response be used Definition Provides a description of the circumstances in which this response should be used (as opposed to one of the alternative responses). Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
graph		0..*	canonical(GraphDefinition)	There are no (further) constraints on this element Element Id MessageDefinition.graph Short description Canonical reference to a GraphDefinition Definition Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a GraphDefinition that it controls what resources are to be added to the bundle when building the document. The GraphDefinition can also specify profiles that apply to the various resources. Comments see Canonical References Data Type canonical(GraphDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a

MessageDefinition	I		MessageDefinition	There are no (further) constraints on this element Element Id MessageDefinition Short description A resource that defines a type of message that can be exchanged between systems Definition Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted. Comments This would be a MIF-level artifact. Data Type MessageDefinition 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()` msd-0:Name should be usable as an identifier for the module by machine processing applications such as code generation `name.matches('[A-Z]([A-Za-z0-9_]){0,254}')` Mappings rim:Entity. Role, or Act v2:N/A rim:N/A
url	Σ I	1..1	uri	Element Id MessageDefinition.url Short description Business Identifier for a given MessageDefinition Definition The business identifier that is used to reference the MessageDefinition and is expected to be consistent from server to server. Requirements Allows the message definition to be referenced by a single globally unique identifier. Comments Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` -MessageDefinition-01:The MessageDefinition.url needs to start with the NHS Wales base. `startsWith('https://fhir.nhs.wales/MessageDefinition/')` Mappings rim:n/a workflow:Definition.url w5:FiveWs.identifier
identifier	Σ	0..*	Identifier	There are no (further) constraints on this element Element Id MessageDefinition.identifier Short description Primary key for the message definition on a given server Definition A formal identifier that is used to identify this message definition when it is represented in other formats, or referenced in a specification, model, design or an instance. Requirements Allows externally provided and/or usable business identifiers to be easily associated with the module. Comments Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this message definition outside of FHIR, where it is not possible to use the logical URI. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier workflow:Definition.identifier w5:FiveWs.identifier objimpl:no-gen-base
version	Σ	0..1	string	There are no (further) constraints on this element Element Id MessageDefinition.version Short description Business version of the message definition Definition The identifier that is used to identify this version of the message definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the message definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. Comments There may be different message definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the message definition with the format [url]\|[version]. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.version w5:FiveWs.version
name	Σ I	0..1	string	There are no (further) constraints on this element Element Id MessageDefinition.name Short description Name for this message definition (computer friendly) Definition A natural language name identifying the message definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. Requirements Support human navigation and code generation. Comments The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
title	Σ	0..1	string	There are no (further) constraints on this element Element Id MessageDefinition.title Short description Name for this message definition (human friendly) Definition A short, descriptive, user-friendly title for the message definition. Comments This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.title
replaces	Σ	0..*	canonical(MessageDefinition)	There are no (further) constraints on this element Element Id MessageDefinition.replaces Short description Takes the place of Definition A MessageDefinition that is superseded by this definition. Comments see Canonical References Data Type canonical(MessageDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
status	Σ ?!	1..1	codeBinding	There are no (further) constraints on this element Element Id MessageDefinition.status Short description draft \| active \| retired \| unknown Definition The status of this message definition. Enables tracking the life-cycle of the content. Comments Allows filtering of message definitions that are appropriate for use versus not. Data Type code Binding The lifecycle status of an artifact. PublicationStatus (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.status w5:FiveWs.status
experimental	Σ	0..1	boolean	There are no (further) constraints on this element Element Id MessageDefinition.experimental Short description For testing purposes, not real usage Definition A Boolean value to indicate that this message definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Requirements Enables experimental content to be developed following the same lifecycle that would be used for a production-level message definition. Comments Allows filtering of message definitions that are appropriate for use versus not. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.experimental w5:FiveWs.class
date	Σ	1..1	dateTime	There are no (further) constraints on this element Element Id MessageDefinition.date Short description Date last changed Alternate names Revision Date Definition The date (and optionally time) when the message definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the message definition changes. Comments Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the message definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. Data Type dateTime Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.date w5:FiveWs.recorded
publisher	Σ	0..1	string	There are no (further) constraints on this element Element Id MessageDefinition.publisher Short description Name of the publisher (organization or individual) Definition The name of the organization or individual that published the message definition. Requirements Helps establish the "authority/credibility" of the message definition. May also allow for contact. Comments Usually an organization but may be an individual. The publisher (or steward) of the message definition is the organization or individual primarily responsible for the maintenance and upkeep of the message definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the message definition. This item SHOULD be populated unless the information is available from context. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.publisher w5:FiveWs.witness
contact	Σ	0..*	ContactDetail	There are no (further) constraints on this element Element Id MessageDefinition.contact Short description Contact details for the publisher Definition Contact details to assist a user in finding and communicating with the publisher. Comments May be a web site, an email address, a telephone number, etc. Data Type ContactDetail Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.contact
description	Σ	1..1	markdown	There are no (further) constraints on this element Element Id MessageDefinition.description Short description Natural language description of the message definition Definition A free text natural language description of the message definition from a consumer's perspective. Comments This description can be used to capture details such as why the message definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the message definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the message definition is presumed to be the predominant language in the place the message definition was created). Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.description
useContext	Σ	0..*	UsageContext	There are no (further) constraints on this element Element Id MessageDefinition.useContext Short description The context that the content is intended to support Definition The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate message definition instances. Requirements Assist in searching for appropriate content. Comments When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. Data Type UsageContext Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.useContext
jurisdiction	Σ	0..*	CodeableConceptBinding	There are no (further) constraints on this element Element Id MessageDefinition.jurisdiction Short description Intended jurisdiction for message definition (if applicable) Definition A legal or geographic region in which the message definition is intended to be used. Comments It may be possible for the message definition to be used in jurisdictions other than those for which it was originally designed or intended. Data Type CodeableConcept Binding Countries and regions within which this artifact is targeted for use. Jurisdiction ValueSet (extensible) 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 workflow:Definition.jurisdiction
purpose	Σ	0..1	markdown	There are no (further) constraints on this element Element Id MessageDefinition.purpose Short description Why this message definition is defined Definition Explanation of why this message definition is needed and why it has been designed as it has. Comments This element does not describe the usage of the message definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this message definition. Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.purpose w5:FiveWs.why[x] objimpl:no-gen-base
copyright		0..1	markdown	There are no (further) constraints on this element Element Id MessageDefinition.copyright Short description Use and/or publishing restrictions Alternate names License, Restrictions Definition A copyright statement relating to the message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message definition. Requirements Consumers must be able to determine any legal restrictions on the use of the message definition and/or its content. Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.copyright objimpl:no-gen-base
base	Σ	0..1	canonical(MessageDefinition)	There are no (further) constraints on this element Element Id MessageDefinition.base Short description Definition this one is based on Definition The MessageDefinition that is the basis for the contents of this resource. Comments see Canonical References Data Type canonical(MessageDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
parent	Σ	0..*	canonical(ActivityDefinition \| PlanDefinition)	There are no (further) constraints on this element Element Id MessageDefinition.parent Short description Protocol/workflow this is part of Definition Identifies a protocol or workflow that this MessageDefinition represents a step in. Comments It should be possible to use MessageDefinition to describe a message to be used by certain steps in a particular protocol as part of a PlanDefinition or ActivityDefinition. Data Type canonical(ActivityDefinition \| PlanDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
event[x]	Σ	1..1	Binding	Element Id MessageDefinition.event[x] Short description Event code or link to the EventDefinition Definition Event code or link to the EventDefinition. Binding NHS Wales Message Events DataStandardsWalesPSOMMessageEvent (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
eventCoding			Coding	Data Type Coding
category	Σ	0..1	codeBinding	There are no (further) constraints on this element Element Id MessageDefinition.category Short description consequence \| currency \| notification Definition The impact of the content of the message. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding The impact of the content of a message. MessageSignificanceCategory (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
focus	Σ I	1..*	BackboneElement	There are no (further) constraints on this element Element Id MessageDefinition.focus Short description Resource(s) that are the subject of the event Definition Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` md-1:Max must be postive int or * `max='' or (max.toInteger() > 0)` Mappings* rim:n/a
code	Σ	1..1	codeBinding	There are no (further) constraints on this element Element Id MessageDefinition.focus.code Short description Type of resource Definition The kind of resource that must be the focus for this message. Comments Multiple focuses addressing different resources may occasionally occur. E.g. to link or unlink a resource from a particular account or encounter, etc. Data Type code Binding One of the resource types defined as part of this version of FHIR. ResourceType (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
profile		0..1	canonical(StructureDefinition)	There are no (further) constraints on this element Element Id MessageDefinition.focus.profile Short description Profile that must be adhered to by focus Definition A profile that reflects constraints for the focal resource (and potentially for related resources). Requirements This profile allows setting boundaries for what content must appear within the message bundle vs. outside based on the declared aggregation constraints on referenced resources on this and related profiles. Comments This should be present for most message definitions. However, if the message focus is only a single resource and there is no need to include referenced resources or otherwise enforce the presence of particular elements, it can be omitted. Data Type canonical(StructureDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
min	Σ	1..1	unsignedInt	There are no (further) constraints on this element Element Id MessageDefinition.focus.min Short description Minimum number of focuses of this type Definition Identifies the minimum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition. Comments 32 bit number; for values larger than this, use decimal Data Type unsignedInt Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
max	I	0..1	string	There are no (further) constraints on this element Element Id MessageDefinition.focus.max Short description Maximum number of focuses of this type Definition Identifies the maximum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
responseRequired		0..1	codeBinding	There are no (further) constraints on this element Element Id MessageDefinition.responseRequired Short description always \| on-error \| never \| on-success Definition Declare at a message definition level whether a response is required or only upon error or success, or never. Comments This enables the capability currently available through MSH-16 (Application Level acknowledgement) in HL7 Version 2 to declare at a message instance level whether a response is required or only upon error or success, or never. Data Type code Binding HL7-defined table of codes which identify conditions under which acknowledgments are required to be returned in response to a message. messageheader-response-request (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General always Mappings rim:n/a v2:MSH-16
allowedResponse		0..*	BackboneElement	There are no (further) constraints on this element Element Id MessageDefinition.allowedResponse Short description Responses to this message Definition Indicates what types of messages may be sent as an application-level response to this message. Comments This indicates an application level response to "close" a transaction implicit in a particular request message. To define a complete workflow scenario, look to the [[PlanDefinition]] resource which allows the definition of complex orchestrations, conditionality, etc. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
message		1..1	canonical(MessageDefinition)	There are no (further) constraints on this element Element Id MessageDefinition.allowedResponse.message Short description Reference to allowed message definition response Definition A reference to the message definition that must be adhered to by this supported response. Comments see Canonical References Data Type canonical(MessageDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
situation		0..1	markdown	There are no (further) constraints on this element Element Id MessageDefinition.allowedResponse.situation Short description When should this response be used Definition Provides a description of the circumstances in which this response should be used (as opposed to one of the alternative responses). Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
graph		0..*	canonical(GraphDefinition)	There are no (further) constraints on this element Element Id MessageDefinition.graph Short description Canonical reference to a GraphDefinition Definition Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a GraphDefinition that it controls what resources are to be added to the bundle when building the document. The GraphDefinition can also specify profiles that apply to the various resources. Comments see Canonical References Data Type canonical(GraphDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a