Extensions for Using Data Elements from FHIR STU3 in FHIR R4
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR STU3 in FHIR R4 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R3_MessageDefinition_R4

Official URL: http://hl7.org/fhir/3.0/StructureDefinition/profile-MessageDefinition Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R3_MessageDefinition_R4

This cross-version profile allows STU3 MessageDefinition content to be represented via FHIR R4 MessageDefinition resources.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageDefinition C 0..* MessageDefinition(4.0.1) A resource that defines a type of message that can be exchanged between systems
Constraints: msd-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... event[x] Σ 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.
.... eventCoding Coding
.... 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 MessageDefinition.implicitRules, MessageDefinition.modifierExtension, MessageDefinition.status, MessageDefinition.date, MessageDefinition.event[x] All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error MessageDefinition.modifierExtension 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}')

This structure is derived from MessageDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageDefinition 0..* MessageDefinition(4.0.1) A resource that defines a type of message that can be exchanged between systems
... replaces
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:replaces 0..* Reference(Cross-version Profile for STU3.MessageDefinition for use in FHIR R4(0.1.0) | MessageDefinition) STU3: replaces additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MessageDefinition.replaces
... base
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:base 0..1 Reference(Cross-version Profile for STU3.MessageDefinition for use in FHIR R4(0.1.0) | MessageDefinition) STU3: base additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MessageDefinition.base
... parent
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:parent 0..* Reference(Cross-version Profile for STU3.ActivityDefinition for use in FHIR R4(0.1.0) | ActivityDefinition | Cross-version Profile for STU3.PlanDefinition for use in FHIR R4(0.1.0) | PlanDefinition) STU3: parent additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MessageDefinition.parent
.... profile
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:profile 0..1 Reference(Cross-version Profile for STU3.StructureDefinition for use in FHIR R4(0.1.0) | StructureDefinition) STU3: profile additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MessageDefinition.focus.profile
... responseRequired
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:responseRequired 0..1 boolean STU3: Is a response required? additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MessageDefinition.responseRequired
... allowedResponse
.... message
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:message 0..1 Reference(Cross-version Profile for STU3.MessageDefinition for use in FHIR R4(0.1.0) | MessageDefinition) STU3: message additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MessageDefinition.allowedResponse.message

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageDefinition C 0..* MessageDefinition(4.0.1) A resource that defines a type of message that can be exchanged between systems
Constraints: msd-0
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url Σ 0..1 uri Business Identifier for a given MessageDefinition
... identifier Σ 0..* Identifier Primary key for the message definition on a given server
... version Σ 0..1 string Business version of the message definition
... name ΣC 0..1 string Name for this message definition (computer friendly)
... title Σ 0..1 string Name for this message definition (human friendly)
... replaces Σ 0..* canonical(MessageDefinition) Takes the place of
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:replaces 0..* Reference(Cross-version Profile for STU3.MessageDefinition for use in FHIR R4(0.1.0) | MessageDefinition) STU3: replaces additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MessageDefinition.replaces
Constraints: ext-1
.... value 0..1 string Primitive value for canonical
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 1..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description Σ 0..1 markdown Natural language description of the message definition
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for message definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose Σ 0..1 markdown Why this message definition is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... base Σ 0..1 canonical(MessageDefinition) Definition this one is based on
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:base 0..1 Reference(Cross-version Profile for STU3.MessageDefinition for use in FHIR R4(0.1.0) | MessageDefinition) STU3: base additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MessageDefinition.base
Constraints: ext-1
.... value 0..1 string Primitive value for canonical
... parent Σ 0..* canonical(ActivityDefinition | PlanDefinition) Protocol/workflow this is part of
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:parent 0..* Reference(Cross-version Profile for STU3.ActivityDefinition for use in FHIR R4(0.1.0) | ActivityDefinition | Cross-version Profile for STU3.PlanDefinition for use in FHIR R4(0.1.0) | PlanDefinition) STU3: parent additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MessageDefinition.parent
Constraints: ext-1
.... value 0..1 string Primitive value for canonical
... event[x] Σ 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.
.... eventCoding Coding
.... eventUri uri
... category Σ 0..1 code consequence | currency | notification
Binding: MessageSignificanceCategory (required): The impact of the content of a message.
... focus ΣC 0..* BackboneElement Resource(s) that are the subject of the event
Constraints: md-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... code Σ 1..1 code Type of resource
Binding: ResourceType . (required): One of the resource types defined as part of this version of FHIR.
.... profile 0..1 canonical(StructureDefinition) Profile that must be adhered to by focus
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:profile 0..1 Reference(Cross-version Profile for STU3.StructureDefinition for use in FHIR R4(0.1.0) | StructureDefinition) STU3: profile additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MessageDefinition.focus.profile
Constraints: ext-1
..... value 0..1 string Primitive value for canonical
.... min Σ 1..1 unsignedInt Minimum number of focuses of this type
.... max C 0..1 string Maximum number of focuses of this type
... 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
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:responseRequired 0..1 boolean STU3: Is a response required? additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MessageDefinition.responseRequired
Constraints: ext-1
.... value 0..1 string Primitive value for code
... allowedResponse 0..* BackboneElement Responses to this message
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... message 1..1 canonical(MessageDefinition) Reference to allowed message definition response
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:message 0..1 Reference(Cross-version Profile for STU3.MessageDefinition for use in FHIR R4(0.1.0) | MessageDefinition) STU3: message additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MessageDefinition.allowedResponse.message
Constraints: ext-1
..... value 0..1 string Primitive value for canonical
.... situation 0..1 markdown When should this response be used
... 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 tx.fhir.org
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 MessageDefinition.meta, MessageDefinition.implicitRules, MessageDefinition.language, MessageDefinition.text, MessageDefinition.extension, MessageDefinition.modifierExtension, MessageDefinition.url, MessageDefinition.identifier, MessageDefinition.version, MessageDefinition.name, MessageDefinition.title, MessageDefinition.replaces, MessageDefinition.replaces.extension, MessageDefinition.replaces.extension:replaces, MessageDefinition.status, MessageDefinition.experimental, MessageDefinition.date, MessageDefinition.publisher, MessageDefinition.contact, MessageDefinition.description, MessageDefinition.useContext, MessageDefinition.jurisdiction, MessageDefinition.purpose, MessageDefinition.copyright, MessageDefinition.base, MessageDefinition.base.extension, MessageDefinition.base.extension:base, MessageDefinition.parent, MessageDefinition.parent.extension, MessageDefinition.parent.extension:parent, MessageDefinition.event[x], MessageDefinition.category, MessageDefinition.focus, MessageDefinition.focus.extension, MessageDefinition.focus.modifierExtension, MessageDefinition.focus.code, MessageDefinition.focus.profile, MessageDefinition.focus.profile.extension, MessageDefinition.focus.profile.extension:profile, MessageDefinition.focus.min, MessageDefinition.focus.max, MessageDefinition.responseRequired, MessageDefinition.responseRequired.extension, MessageDefinition.responseRequired.extension:responseRequired, MessageDefinition.allowedResponse, MessageDefinition.allowedResponse.extension, MessageDefinition.allowedResponse.modifierExtension, MessageDefinition.allowedResponse.message, MessageDefinition.allowedResponse.message.extension, MessageDefinition.allowedResponse.message.extension:message, MessageDefinition.allowedResponse.situation, MessageDefinition.graph All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error MessageDefinition.extension, MessageDefinition.modifierExtension, MessageDefinition.replaces.extension, MessageDefinition.replaces.extension:replaces, MessageDefinition.base.extension, MessageDefinition.base.extension:base, MessageDefinition.parent.extension, MessageDefinition.parent.extension:parent, MessageDefinition.focus.extension, MessageDefinition.focus.modifierExtension, MessageDefinition.focus.profile.extension, MessageDefinition.focus.profile.extension:profile, MessageDefinition.responseRequired.extension, MessageDefinition.responseRequired.extension:responseRequired, MessageDefinition.allowedResponse.extension, MessageDefinition.allowedResponse.modifierExtension, MessageDefinition.allowedResponse.message.extension, MessageDefinition.allowedResponse.message.extension:message 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}')

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageDefinition C 0..* MessageDefinition(4.0.1) A resource that defines a type of message that can be exchanged between systems
Constraints: msd-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... event[x] Σ 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.
.... eventCoding Coding
.... 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 MessageDefinition.implicitRules, MessageDefinition.modifierExtension, MessageDefinition.status, MessageDefinition.date, MessageDefinition.event[x] All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error MessageDefinition.modifierExtension 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}')

Differential View

This structure is derived from MessageDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageDefinition 0..* MessageDefinition(4.0.1) A resource that defines a type of message that can be exchanged between systems
... replaces
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:replaces 0..* Reference(Cross-version Profile for STU3.MessageDefinition for use in FHIR R4(0.1.0) | MessageDefinition) STU3: replaces additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MessageDefinition.replaces
... base
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:base 0..1 Reference(Cross-version Profile for STU3.MessageDefinition for use in FHIR R4(0.1.0) | MessageDefinition) STU3: base additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MessageDefinition.base
... parent
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:parent 0..* Reference(Cross-version Profile for STU3.ActivityDefinition for use in FHIR R4(0.1.0) | ActivityDefinition | Cross-version Profile for STU3.PlanDefinition for use in FHIR R4(0.1.0) | PlanDefinition) STU3: parent additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MessageDefinition.parent
.... profile
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:profile 0..1 Reference(Cross-version Profile for STU3.StructureDefinition for use in FHIR R4(0.1.0) | StructureDefinition) STU3: profile additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MessageDefinition.focus.profile
... responseRequired
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:responseRequired 0..1 boolean STU3: Is a response required? additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MessageDefinition.responseRequired
... allowedResponse
.... message
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:message 0..1 Reference(Cross-version Profile for STU3.MessageDefinition for use in FHIR R4(0.1.0) | MessageDefinition) STU3: message additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MessageDefinition.allowedResponse.message

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageDefinition C 0..* MessageDefinition(4.0.1) A resource that defines a type of message that can be exchanged between systems
Constraints: msd-0
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url Σ 0..1 uri Business Identifier for a given MessageDefinition
... identifier Σ 0..* Identifier Primary key for the message definition on a given server
... version Σ 0..1 string Business version of the message definition
... name ΣC 0..1 string Name for this message definition (computer friendly)
... title Σ 0..1 string Name for this message definition (human friendly)
... replaces Σ 0..* canonical(MessageDefinition) Takes the place of
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:replaces 0..* Reference(Cross-version Profile for STU3.MessageDefinition for use in FHIR R4(0.1.0) | MessageDefinition) STU3: replaces additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MessageDefinition.replaces
Constraints: ext-1
.... value 0..1 string Primitive value for canonical
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 1..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description Σ 0..1 markdown Natural language description of the message definition
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for message definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose Σ 0..1 markdown Why this message definition is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... base Σ 0..1 canonical(MessageDefinition) Definition this one is based on
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:base 0..1 Reference(Cross-version Profile for STU3.MessageDefinition for use in FHIR R4(0.1.0) | MessageDefinition) STU3: base additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MessageDefinition.base
Constraints: ext-1
.... value 0..1 string Primitive value for canonical
... parent Σ 0..* canonical(ActivityDefinition | PlanDefinition) Protocol/workflow this is part of
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:parent 0..* Reference(Cross-version Profile for STU3.ActivityDefinition for use in FHIR R4(0.1.0) | ActivityDefinition | Cross-version Profile for STU3.PlanDefinition for use in FHIR R4(0.1.0) | PlanDefinition) STU3: parent additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MessageDefinition.parent
Constraints: ext-1
.... value 0..1 string Primitive value for canonical
... event[x] Σ 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.
.... eventCoding Coding
.... eventUri uri
... category Σ 0..1 code consequence | currency | notification
Binding: MessageSignificanceCategory (required): The impact of the content of a message.
... focus ΣC 0..* BackboneElement Resource(s) that are the subject of the event
Constraints: md-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... code Σ 1..1 code Type of resource
Binding: ResourceType . (required): One of the resource types defined as part of this version of FHIR.
.... profile 0..1 canonical(StructureDefinition) Profile that must be adhered to by focus
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:profile 0..1 Reference(Cross-version Profile for STU3.StructureDefinition for use in FHIR R4(0.1.0) | StructureDefinition) STU3: profile additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MessageDefinition.focus.profile
Constraints: ext-1
..... value 0..1 string Primitive value for canonical
.... min Σ 1..1 unsignedInt Minimum number of focuses of this type
.... max C 0..1 string Maximum number of focuses of this type
... 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
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:responseRequired 0..1 boolean STU3: Is a response required? additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MessageDefinition.responseRequired
Constraints: ext-1
.... value 0..1 string Primitive value for code
... allowedResponse 0..* BackboneElement Responses to this message
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... message 1..1 canonical(MessageDefinition) Reference to allowed message definition response
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:message 0..1 Reference(Cross-version Profile for STU3.MessageDefinition for use in FHIR R4(0.1.0) | MessageDefinition) STU3: message additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MessageDefinition.allowedResponse.message
Constraints: ext-1
..... value 0..1 string Primitive value for canonical
.... situation 0..1 markdown When should this response be used
... 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 tx.fhir.org
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 MessageDefinition.meta, MessageDefinition.implicitRules, MessageDefinition.language, MessageDefinition.text, MessageDefinition.extension, MessageDefinition.modifierExtension, MessageDefinition.url, MessageDefinition.identifier, MessageDefinition.version, MessageDefinition.name, MessageDefinition.title, MessageDefinition.replaces, MessageDefinition.replaces.extension, MessageDefinition.replaces.extension:replaces, MessageDefinition.status, MessageDefinition.experimental, MessageDefinition.date, MessageDefinition.publisher, MessageDefinition.contact, MessageDefinition.description, MessageDefinition.useContext, MessageDefinition.jurisdiction, MessageDefinition.purpose, MessageDefinition.copyright, MessageDefinition.base, MessageDefinition.base.extension, MessageDefinition.base.extension:base, MessageDefinition.parent, MessageDefinition.parent.extension, MessageDefinition.parent.extension:parent, MessageDefinition.event[x], MessageDefinition.category, MessageDefinition.focus, MessageDefinition.focus.extension, MessageDefinition.focus.modifierExtension, MessageDefinition.focus.code, MessageDefinition.focus.profile, MessageDefinition.focus.profile.extension, MessageDefinition.focus.profile.extension:profile, MessageDefinition.focus.min, MessageDefinition.focus.max, MessageDefinition.responseRequired, MessageDefinition.responseRequired.extension, MessageDefinition.responseRequired.extension:responseRequired, MessageDefinition.allowedResponse, MessageDefinition.allowedResponse.extension, MessageDefinition.allowedResponse.modifierExtension, MessageDefinition.allowedResponse.message, MessageDefinition.allowedResponse.message.extension, MessageDefinition.allowedResponse.message.extension:message, MessageDefinition.allowedResponse.situation, MessageDefinition.graph All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error MessageDefinition.extension, MessageDefinition.modifierExtension, MessageDefinition.replaces.extension, MessageDefinition.replaces.extension:replaces, MessageDefinition.base.extension, MessageDefinition.base.extension:base, MessageDefinition.parent.extension, MessageDefinition.parent.extension:parent, MessageDefinition.focus.extension, MessageDefinition.focus.modifierExtension, MessageDefinition.focus.profile.extension, MessageDefinition.focus.profile.extension:profile, MessageDefinition.responseRequired.extension, MessageDefinition.responseRequired.extension:responseRequired, MessageDefinition.allowedResponse.extension, MessageDefinition.allowedResponse.modifierExtension, MessageDefinition.allowedResponse.message.extension, MessageDefinition.allowedResponse.message.extension:message 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}')

 

Other representations of profile: CSV, Excel, Schematron