Content Repository Management Infrastructure Implementation Guide
3.0.0-ballot - STU 3 Ballot International flag

Content Repository Management Infrastructure Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/crmi-ig/ and changes regularly. See the Directory of published versions

Resource Profile: CRMI Shareable MessageDefinition

Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablemessagedefinition Version: 3.0.0-ballot
Standards status: Draft Maturity Level: 1 Computable Name: CRMIShareableMessageDefinition
Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.42.89

Enforces the minimum information set for message definition metadata required by HL7 and other organizations that share and publish message definitions

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
MessageDefinition C 1..1 MessageDefinition A resource that defines a type of message that can be exchanged between systems
Constraints: msd-0, shr-1
MessageDefinition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
MessageDefinition.Slices for extension Content/Rules for all slices
MessageDefinition.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
MessageDefinition.Slices for extension.extension:versionAlgorithm This element must be supported. 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
MessageDefinition.Slices for extension.extension:versionPolicy 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
MessageDefinition.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
MessageDefinition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
MessageDefinition.url This element must be supported. This element is included in summaries. 1..1 uri Business Identifier for a given MessageDefinition
MessageDefinition.version This element must be supported. This element is included in summaries. 1..1 string Business version of the message definition
MessageDefinition.name This element must be supported. This element is included in summaries. C 0..1 string Name for this message definition (computer friendly)
MessageDefinition.title This element must be supported. This element is included in summaries. 1..1 string Name for this message definition (human friendly)
MessageDefinition.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
MessageDefinition.experimental This element must be supported. This element is included in summaries. 1..1 boolean For testing purposes, not real usage
MessageDefinition.date This element is included in summaries. 1..1 dateTime Date last changed
MessageDefinition.publisher This element must be supported. This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
MessageDefinition.description This element must be supported. This element is included in summaries. 1..1 markdown Natural language description of the message definition
MessageDefinition.event[x] This element is included in summaries. 1..1 Event code or link to the EventDefinition
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.
MessageDefinition.event[x].eventCoding Coding
MessageDefinition.event[x].eventUri uri

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MessageDefinition.status Base required PublicationStatus 📍4.0.1 FHIR Std.
MessageDefinition.event[x] Base example MessageEvent 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MessageDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MessageDefinition 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-4 error MessageDefinition 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-5 error MessageDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MessageDefinition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
msd-0 warning MessageDefinition 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}')
shr-1 error MessageDefinition If knowledge capabilities are stated, they SHALL include shareable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()

This structure is derived from MessageDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: doco
MessageDefinition C 1..1 MessageDefinition A resource that defines a type of message that can be exchanged between systems
Constraints: shr-1
MessageDefinition.Slices for extension Content/Rules for all slices
MessageDefinition.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
MessageDefinition.Slices for extension.extension:versionAlgorithm This element must be supported. 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
MessageDefinition.Slices for extension.extension:versionPolicy 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
MessageDefinition.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
MessageDefinition.url This element must be supported. 1..1 uri Business Identifier for a given MessageDefinition
MessageDefinition.version This element must be supported. 1..1 string Business version of the message definition
MessageDefinition.title This element must be supported. 1..1 string Name for this message definition (human friendly)
MessageDefinition.status This element must be supported. 1..1 code draft | active | retired | unknown
MessageDefinition.experimental This element must be supported. 1..1 boolean For testing purposes, not real usage
MessageDefinition.publisher This element must be supported. 0..1 string Name of the publisher (organization or individual)
MessageDefinition.description This element must be supported. 1..1 markdown Natural language description of the message definition

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
shr-1 error MessageDefinition If knowledge capabilities are stated, they SHALL include shareable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()
NameFlagsCard.TypeDescription & Constraints    Filter: doco
MessageDefinition C 1..1 MessageDefinition A resource that defines a type of message that can be exchanged between systems
Constraints: msd-0, shr-1
MessageDefinition.id This element is included in summaries. 0..1 id Logical id of this artifact
MessageDefinition.meta This element is included in summaries. 0..1 Meta Metadata about the resource
MessageDefinition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
MessageDefinition.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
MessageDefinition.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
MessageDefinition.contained 0..* Resource Contained, inline Resources
MessageDefinition.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
MessageDefinition.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
MessageDefinition.Slices for extension.extension:versionAlgorithm This element must be supported. 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
MessageDefinition.Slices for extension.extension:versionPolicy 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
MessageDefinition.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
MessageDefinition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
MessageDefinition.url This element must be supported. This element is included in summaries. 1..1 uri Business Identifier for a given MessageDefinition
MessageDefinition.identifier This element is included in summaries. 0..* Identifier Primary key for the message definition on a given server
MessageDefinition.version This element must be supported. This element is included in summaries. 1..1 string Business version of the message definition
MessageDefinition.name This element must be supported. This element is included in summaries. C 0..1 string Name for this message definition (computer friendly)
MessageDefinition.title This element must be supported. This element is included in summaries. 1..1 string Name for this message definition (human friendly)
MessageDefinition.replaces This element is included in summaries. 0..* canonical(MessageDefinition) Takes the place of
MessageDefinition.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
MessageDefinition.experimental This element must be supported. This element is included in summaries. 1..1 boolean For testing purposes, not real usage
MessageDefinition.date This element is included in summaries. 1..1 dateTime Date last changed
MessageDefinition.publisher This element must be supported. This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
MessageDefinition.contact This element is included in summaries. 0..* ContactDetail Contact details for the publisher
MessageDefinition.description This element must be supported. This element is included in summaries. 1..1 markdown Natural language description of the message definition
MessageDefinition.useContext This element is included in summaries. 0..* UsageContext The context that the content is intended to support
MessageDefinition.jurisdiction This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for message definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
MessageDefinition.purpose This element is included in summaries. 0..1 markdown Why this message definition is defined
MessageDefinition.copyright 0..1 markdown Use and/or publishing restrictions
MessageDefinition.base This element is included in summaries. 0..1 canonical(MessageDefinition) Definition this one is based on
MessageDefinition.parent This element is included in summaries. 0..* canonical(ActivityDefinition | PlanDefinition) Protocol/workflow this is part of
MessageDefinition.event[x] This element is included in summaries. 1..1 Event code or link to the EventDefinition
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.
MessageDefinition.event[x].eventCoding Coding
MessageDefinition.event[x].eventUri uri
MessageDefinition.category This element is included in summaries. 0..1 code consequence | currency | notification
Binding: MessageSignificanceCategory (required): The impact of the content of a message.
MessageDefinition.focus This element is included in summaries. C 0..* BackboneElement Resource(s) that are the subject of the event
Constraints: md-1
MessageDefinition.focus.id 0..1 string Unique id for inter-element referencing
MessageDefinition.focus.extension 0..* Extension Additional content defined by implementations
MessageDefinition.focus.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MessageDefinition.focus.code This element is included in summaries. 1..1 code Type of resource
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
MessageDefinition.focus.profile 0..1 canonical(StructureDefinition) Profile that must be adhered to by focus
MessageDefinition.focus.min This element is included in summaries. 1..1 unsignedInt Minimum number of focuses of this type
MessageDefinition.focus.max C 0..1 string Maximum number of focuses of this type
MessageDefinition.responseRequired 0..1 code always | on-error | never | on-success
Binding: messageheader-response-request (required): HL7-defined table of codes which identify conditions under which acknowledgments are required to be returned in response to a message.
Example General: always
MessageDefinition.allowedResponse 0..* BackboneElement Responses to this message
MessageDefinition.allowedResponse.id 0..1 string Unique id for inter-element referencing
MessageDefinition.allowedResponse.extension 0..* Extension Additional content defined by implementations
MessageDefinition.allowedResponse.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MessageDefinition.allowedResponse.message 1..1 canonical(MessageDefinition) Reference to allowed message definition response
MessageDefinition.allowedResponse.situation 0..1 markdown When should this response be used
MessageDefinition.graph 0..* canonical(GraphDefinition) Canonical reference to a GraphDefinition

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MessageDefinition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
MessageDefinition.status Base required PublicationStatus 📍4.0.1 FHIR Std.
MessageDefinition.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
MessageDefinition.event[x] Base example MessageEvent 📍4.0.1 FHIR Std.
MessageDefinition.category Base required MessageSignificanceCategory 📍4.0.1 FHIR Std.
MessageDefinition.focus.​code Base required ResourceType 📍4.0.1 FHIR Std.
MessageDefinition.responseRequired Base required messageheader-response-request 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MessageDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MessageDefinition 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-4 error MessageDefinition 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-5 error MessageDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MessageDefinition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
md-1 error MessageDefinition.focus Max must be postive int or * max='*' or (max.toInteger() > 0)
msd-0 warning MessageDefinition 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}')
shr-1 error MessageDefinition If knowledge capabilities are stated, they SHALL include shareable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
MessageDefinition C 1..1 MessageDefinition A resource that defines a type of message that can be exchanged between systems
Constraints: msd-0, shr-1
MessageDefinition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
MessageDefinition.Slices for extension Content/Rules for all slices
MessageDefinition.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
MessageDefinition.Slices for extension.extension:versionAlgorithm This element must be supported. 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
MessageDefinition.Slices for extension.extension:versionPolicy 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
MessageDefinition.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
MessageDefinition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
MessageDefinition.url This element must be supported. This element is included in summaries. 1..1 uri Business Identifier for a given MessageDefinition
MessageDefinition.version This element must be supported. This element is included in summaries. 1..1 string Business version of the message definition
MessageDefinition.name This element must be supported. This element is included in summaries. C 0..1 string Name for this message definition (computer friendly)
MessageDefinition.title This element must be supported. This element is included in summaries. 1..1 string Name for this message definition (human friendly)
MessageDefinition.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
MessageDefinition.experimental This element must be supported. This element is included in summaries. 1..1 boolean For testing purposes, not real usage
MessageDefinition.date This element is included in summaries. 1..1 dateTime Date last changed
MessageDefinition.publisher This element must be supported. This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
MessageDefinition.description This element must be supported. This element is included in summaries. 1..1 markdown Natural language description of the message definition
MessageDefinition.event[x] This element is included in summaries. 1..1 Event code or link to the EventDefinition
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.
MessageDefinition.event[x].eventCoding Coding
MessageDefinition.event[x].eventUri uri

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MessageDefinition.status Base required PublicationStatus 📍4.0.1 FHIR Std.
MessageDefinition.event[x] Base example MessageEvent 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MessageDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MessageDefinition 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-4 error MessageDefinition 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-5 error MessageDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MessageDefinition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
msd-0 warning MessageDefinition 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}')
shr-1 error MessageDefinition If knowledge capabilities are stated, they SHALL include shareable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()

Differential View

This structure is derived from MessageDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: doco
MessageDefinition C 1..1 MessageDefinition A resource that defines a type of message that can be exchanged between systems
Constraints: shr-1
MessageDefinition.Slices for extension Content/Rules for all slices
MessageDefinition.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
MessageDefinition.Slices for extension.extension:versionAlgorithm This element must be supported. 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
MessageDefinition.Slices for extension.extension:versionPolicy 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
MessageDefinition.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
MessageDefinition.url This element must be supported. 1..1 uri Business Identifier for a given MessageDefinition
MessageDefinition.version This element must be supported. 1..1 string Business version of the message definition
MessageDefinition.name This element must be supported. 0..1 string Name for this message definition (computer friendly)
MessageDefinition.title This element must be supported. 1..1 string Name for this message definition (human friendly)
MessageDefinition.status This element must be supported. 1..1 code draft | active | retired | unknown
MessageDefinition.experimental This element must be supported. 1..1 boolean For testing purposes, not real usage
MessageDefinition.publisher This element must be supported. 0..1 string Name of the publisher (organization or individual)
MessageDefinition.description This element must be supported. 1..1 markdown Natural language description of the message definition

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
shr-1 error MessageDefinition If knowledge capabilities are stated, they SHALL include shareable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
MessageDefinition C 1..1 MessageDefinition A resource that defines a type of message that can be exchanged between systems
Constraints: msd-0, shr-1
MessageDefinition.id This element is included in summaries. 0..1 id Logical id of this artifact
MessageDefinition.meta This element is included in summaries. 0..1 Meta Metadata about the resource
MessageDefinition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
MessageDefinition.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
MessageDefinition.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
MessageDefinition.contained 0..* Resource Contained, inline Resources
MessageDefinition.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
MessageDefinition.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
MessageDefinition.Slices for extension.extension:versionAlgorithm This element must be supported. 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
MessageDefinition.Slices for extension.extension:versionPolicy 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
MessageDefinition.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
MessageDefinition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
MessageDefinition.url This element must be supported. This element is included in summaries. 1..1 uri Business Identifier for a given MessageDefinition
MessageDefinition.identifier This element is included in summaries. 0..* Identifier Primary key for the message definition on a given server
MessageDefinition.version This element must be supported. This element is included in summaries. 1..1 string Business version of the message definition
MessageDefinition.name This element must be supported. This element is included in summaries. C 0..1 string Name for this message definition (computer friendly)
MessageDefinition.title This element must be supported. This element is included in summaries. 1..1 string Name for this message definition (human friendly)
MessageDefinition.replaces This element is included in summaries. 0..* canonical(MessageDefinition) Takes the place of
MessageDefinition.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
MessageDefinition.experimental This element must be supported. This element is included in summaries. 1..1 boolean For testing purposes, not real usage
MessageDefinition.date This element is included in summaries. 1..1 dateTime Date last changed
MessageDefinition.publisher This element must be supported. This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
MessageDefinition.contact This element is included in summaries. 0..* ContactDetail Contact details for the publisher
MessageDefinition.description This element must be supported. This element is included in summaries. 1..1 markdown Natural language description of the message definition
MessageDefinition.useContext This element is included in summaries. 0..* UsageContext The context that the content is intended to support
MessageDefinition.jurisdiction This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for message definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
MessageDefinition.purpose This element is included in summaries. 0..1 markdown Why this message definition is defined
MessageDefinition.copyright 0..1 markdown Use and/or publishing restrictions
MessageDefinition.base This element is included in summaries. 0..1 canonical(MessageDefinition) Definition this one is based on
MessageDefinition.parent This element is included in summaries. 0..* canonical(ActivityDefinition | PlanDefinition) Protocol/workflow this is part of
MessageDefinition.event[x] This element is included in summaries. 1..1 Event code or link to the EventDefinition
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.
MessageDefinition.event[x].eventCoding Coding
MessageDefinition.event[x].eventUri uri
MessageDefinition.category This element is included in summaries. 0..1 code consequence | currency | notification
Binding: MessageSignificanceCategory (required): The impact of the content of a message.
MessageDefinition.focus This element is included in summaries. C 0..* BackboneElement Resource(s) that are the subject of the event
Constraints: md-1
MessageDefinition.focus.id 0..1 string Unique id for inter-element referencing
MessageDefinition.focus.extension 0..* Extension Additional content defined by implementations
MessageDefinition.focus.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MessageDefinition.focus.code This element is included in summaries. 1..1 code Type of resource
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
MessageDefinition.focus.profile 0..1 canonical(StructureDefinition) Profile that must be adhered to by focus
MessageDefinition.focus.min This element is included in summaries. 1..1 unsignedInt Minimum number of focuses of this type
MessageDefinition.focus.max C 0..1 string Maximum number of focuses of this type
MessageDefinition.responseRequired 0..1 code always | on-error | never | on-success
Binding: messageheader-response-request (required): HL7-defined table of codes which identify conditions under which acknowledgments are required to be returned in response to a message.
Example General: always
MessageDefinition.allowedResponse 0..* BackboneElement Responses to this message
MessageDefinition.allowedResponse.id 0..1 string Unique id for inter-element referencing
MessageDefinition.allowedResponse.extension 0..* Extension Additional content defined by implementations
MessageDefinition.allowedResponse.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MessageDefinition.allowedResponse.message 1..1 canonical(MessageDefinition) Reference to allowed message definition response
MessageDefinition.allowedResponse.situation 0..1 markdown When should this response be used
MessageDefinition.graph 0..* canonical(GraphDefinition) Canonical reference to a GraphDefinition

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MessageDefinition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
MessageDefinition.status Base required PublicationStatus 📍4.0.1 FHIR Std.
MessageDefinition.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
MessageDefinition.event[x] Base example MessageEvent 📍4.0.1 FHIR Std.
MessageDefinition.category Base required MessageSignificanceCategory 📍4.0.1 FHIR Std.
MessageDefinition.focus.​code Base required ResourceType 📍4.0.1 FHIR Std.
MessageDefinition.responseRequired Base required messageheader-response-request 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MessageDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MessageDefinition 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-4 error MessageDefinition 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-5 error MessageDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MessageDefinition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
md-1 error MessageDefinition.focus Max must be postive int or * max='*' or (max.toInteger() > 0)
msd-0 warning MessageDefinition 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}')
shr-1 error MessageDefinition If knowledge capabilities are stated, they SHALL include shareable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()

 

Other representations of profile: CSV, Excel, Schematron