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

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

Resource Profile: Profile_R5_MessageDefinition_R3

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

This cross-version profile allows R5 MessageDefinition content to be represented via FHIR STU3 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 0..* MessageDefinition A resource that defines a type of message that can be exchanged between systems
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionAlgorithm 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
.... extension:copyrightLabel 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:graph 0..1 uri R5: Canonical reference to a GraphDefinition (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.graph
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... experimental ?!Σ 0..1 boolean For testing purposes, not real usage
... date Σ 1..1 dateTime Date this was last changed
... event Σ 1..1 Coding Event type
Binding: MessageEvent (example): One of the message events defined as part of FHIR.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:event 1..1 uri R5: Event code or link to the EventDefinition additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.event

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MessageDefinition.status Base required PublicationStatus 📍3.0.2 FHIR Std.
MessageDefinition.event Base example MessageEvent 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error MessageDefinition If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from MessageDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageDefinition 0..* MessageDefinition A resource that defines a type of message that can be exchanged between systems
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionAlgorithm 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
.... extension:copyrightLabel 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:graph 0..1 uri R5: Canonical reference to a GraphDefinition (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.graph
... contact
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:contact 0..* (Complex) R5: contact additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.contact
... base
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:base 0..1 uri R5: base additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.base
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:parent 0..* uri R5: parent additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.parent
... replaces
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:replaces 0..* uri R5: replaces additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.replaces
... event
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:event 0..1 uri R5: Event code or link to the EventDefinition additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.event
... focus
.... code
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:code 0..1 code R5: code additional codes
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.focus.code
Binding: R5ResourceTypesForR3 (0.1.0) (required): One of the resource types defined as part of this version of FHIR.
.... profile
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:profile 0..1 uri R5: profile additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.focus.profile
... responseRequired
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:responseRequired 0..1 code R5: always | on-error | never | on-success additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.responseRequired
Binding: messageheader-response-request (required): This enables the capability currently available through MSH-16 (Application Level acknowledgement) in HL7 Version 2 to declare at a message definition level whether a response is required or only upon error or success, or never.
... allowedResponse
.... message
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:message 0..1 uri R5: message additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.allowedResponse.message

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageDefinition 0..* MessageDefinition A resource that defines a type of message that can be exchanged between systems
... 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: Common Languages . (extensible): A human language.
Additional BindingsPurpose
All Languages 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionAlgorithm 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
.... extension:copyrightLabel 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:graph 0..1 uri R5: Canonical reference to a GraphDefinition (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.graph
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 0..1 uri Logical URI to reference this message definition (globally unique)
... identifier Σ 0..1 Identifier Additional identifier for the message definition
... version Σ 0..1 string Business version of the message definition
... name Σ 0..1 string Name for this message definition (computer friendly)
... title Σ 0..1 string Name for this message definition (human friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of a Value Set or Concept Map.
... experimental ?!Σ 0..1 boolean For testing purposes, not real usage
... date Σ 1..1 dateTime Date this was last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:contact 0..* (Complex) R5: contact additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.contact
.... name Σ 0..1 string Name of an individual to contact
.... telecom Σ 0..* ContactPoint Contact details for individual or organization
... description Σ 0..1 markdown Natural language description of the message definition
... useContext Σ 0..* UsageContext Context 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 Reference(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
..... extension:base 0..1 uri R5: base additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.base
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... parent Σ 0..* Reference(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
..... extension:parent 0..* uri R5: parent additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.parent
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... replaces Σ 0..* Reference(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
..... extension:replaces 0..* uri R5: replaces additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.replaces
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... event Σ 1..1 Coding Event type
Binding: MessageEvent (example): One of the message events defined as part of FHIR.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:event 1..1 uri R5: Event code or link to the EventDefinition additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.event
.... system Σ 0..1 uri Identity of the terminology system
.... version Σ 0..1 string Version of the system - if relevant
.... code Σ 0..1 code Symbol in syntax defined by the system
.... display Σ 0..1 string Representation defined by the system
.... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... 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 xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... code Σ 1..1 code Type of resource
Binding: ResourceType . (required): One of the resource types defined as part of FHIR.
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:code 0..1 code R5: code additional codes
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.focus.code
Binding: R5ResourceTypesForR3 (0.1.0) (required): One of the resource types defined as part of this version of FHIR.
..... value 0..1 code Primitive value for code
.... profile 0..1 Reference(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
...... extension:profile 0..1 uri R5: profile additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.focus.profile
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... min 0..1 unsignedInt Minimum number of focuses of this type
.... max C 0..1 string Maximum number of focuses of this type
... responseRequired 0..1 boolean Is a response required?
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:responseRequired 0..1 code R5: always | on-error | never | on-success additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.responseRequired
Binding: messageheader-response-request (required): This enables the capability currently available through MSH-16 (Application Level acknowledgement) in HL7 Version 2 to declare at a message definition level whether a response is required or only upon error or success, or never.
.... value 0..1 boolean Primitive value for boolean
... allowedResponse 0..* BackboneElement Responses to this message
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... message 1..1 Reference(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
...... extension:message 1..1 uri R5: message additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.allowedResponse.message
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... situation 0..1 markdown When should this response be used

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MessageDefinition.language Base extensible Common Languages . 📍3.0.2 tx.fhir.org
MessageDefinition.status Base required PublicationStatus 📍3.0.2 FHIR Std.
MessageDefinition.jurisdiction Base extensible Jurisdiction ValueSet 📍3.0.2 FHIR Std.
MessageDefinition.event Base example MessageEvent 📍3.0.2 FHIR Std.
MessageDefinition.category Base required MessageSignificanceCategory 📍3.0.2 FHIR Std.
MessageDefinition.focus.​code Base required ResourceType . 📍3.0.2 tx.fhir.org

Constraints

Id Grade Path(s) Description Expression
dom-1 error MessageDefinition If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (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)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageDefinition 0..* MessageDefinition A resource that defines a type of message that can be exchanged between systems
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionAlgorithm 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
.... extension:copyrightLabel 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:graph 0..1 uri R5: Canonical reference to a GraphDefinition (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.graph
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... experimental ?!Σ 0..1 boolean For testing purposes, not real usage
... date Σ 1..1 dateTime Date this was last changed
... event Σ 1..1 Coding Event type
Binding: MessageEvent (example): One of the message events defined as part of FHIR.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:event 1..1 uri R5: Event code or link to the EventDefinition additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.event

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MessageDefinition.status Base required PublicationStatus 📍3.0.2 FHIR Std.
MessageDefinition.event Base example MessageEvent 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error MessageDefinition If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from MessageDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageDefinition 0..* MessageDefinition A resource that defines a type of message that can be exchanged between systems
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionAlgorithm 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
.... extension:copyrightLabel 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:graph 0..1 uri R5: Canonical reference to a GraphDefinition (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.graph
... contact
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:contact 0..* (Complex) R5: contact additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.contact
... base
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:base 0..1 uri R5: base additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.base
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:parent 0..* uri R5: parent additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.parent
... replaces
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:replaces 0..* uri R5: replaces additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.replaces
... event
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:event 0..1 uri R5: Event code or link to the EventDefinition additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.event
... focus
.... code
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:code 0..1 code R5: code additional codes
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.focus.code
Binding: R5ResourceTypesForR3 (0.1.0) (required): One of the resource types defined as part of this version of FHIR.
.... profile
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:profile 0..1 uri R5: profile additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.focus.profile
... responseRequired
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:responseRequired 0..1 code R5: always | on-error | never | on-success additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.responseRequired
Binding: messageheader-response-request (required): This enables the capability currently available through MSH-16 (Application Level acknowledgement) in HL7 Version 2 to declare at a message definition level whether a response is required or only upon error or success, or never.
... allowedResponse
.... message
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:message 0..1 uri R5: message additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.allowedResponse.message

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageDefinition 0..* MessageDefinition A resource that defines a type of message that can be exchanged between systems
... 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: Common Languages . (extensible): A human language.
Additional BindingsPurpose
All Languages 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionAlgorithm 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
.... extension:copyrightLabel 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:graph 0..1 uri R5: Canonical reference to a GraphDefinition (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.graph
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 0..1 uri Logical URI to reference this message definition (globally unique)
... identifier Σ 0..1 Identifier Additional identifier for the message definition
... version Σ 0..1 string Business version of the message definition
... name Σ 0..1 string Name for this message definition (computer friendly)
... title Σ 0..1 string Name for this message definition (human friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of a Value Set or Concept Map.
... experimental ?!Σ 0..1 boolean For testing purposes, not real usage
... date Σ 1..1 dateTime Date this was last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:contact 0..* (Complex) R5: contact additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.contact
.... name Σ 0..1 string Name of an individual to contact
.... telecom Σ 0..* ContactPoint Contact details for individual or organization
... description Σ 0..1 markdown Natural language description of the message definition
... useContext Σ 0..* UsageContext Context 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 Reference(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
..... extension:base 0..1 uri R5: base additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.base
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... parent Σ 0..* Reference(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
..... extension:parent 0..* uri R5: parent additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.parent
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... replaces Σ 0..* Reference(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
..... extension:replaces 0..* uri R5: replaces additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.replaces
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... event Σ 1..1 Coding Event type
Binding: MessageEvent (example): One of the message events defined as part of FHIR.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:event 1..1 uri R5: Event code or link to the EventDefinition additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.event
.... system Σ 0..1 uri Identity of the terminology system
.... version Σ 0..1 string Version of the system - if relevant
.... code Σ 0..1 code Symbol in syntax defined by the system
.... display Σ 0..1 string Representation defined by the system
.... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... 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 xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... code Σ 1..1 code Type of resource
Binding: ResourceType . (required): One of the resource types defined as part of FHIR.
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:code 0..1 code R5: code additional codes
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.focus.code
Binding: R5ResourceTypesForR3 (0.1.0) (required): One of the resource types defined as part of this version of FHIR.
..... value 0..1 code Primitive value for code
.... profile 0..1 Reference(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
...... extension:profile 0..1 uri R5: profile additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.focus.profile
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... min 0..1 unsignedInt Minimum number of focuses of this type
.... max C 0..1 string Maximum number of focuses of this type
... responseRequired 0..1 boolean Is a response required?
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:responseRequired 0..1 code R5: always | on-error | never | on-success additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.responseRequired
Binding: messageheader-response-request (required): This enables the capability currently available through MSH-16 (Application Level acknowledgement) in HL7 Version 2 to declare at a message definition level whether a response is required or only upon error or success, or never.
.... value 0..1 boolean Primitive value for boolean
... allowedResponse 0..* BackboneElement Responses to this message
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... message 1..1 Reference(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
...... extension:message 1..1 uri R5: message additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MessageDefinition.allowedResponse.message
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... situation 0..1 markdown When should this response be used

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MessageDefinition.language Base extensible Common Languages . 📍3.0.2 tx.fhir.org
MessageDefinition.status Base required PublicationStatus 📍3.0.2 FHIR Std.
MessageDefinition.jurisdiction Base extensible Jurisdiction ValueSet 📍3.0.2 FHIR Std.
MessageDefinition.event Base example MessageEvent 📍3.0.2 FHIR Std.
MessageDefinition.category Base required MessageSignificanceCategory 📍3.0.2 FHIR Std.
MessageDefinition.focus.​code Base required ResourceType . 📍3.0.2 tx.fhir.org

Constraints

Id Grade Path(s) Description Expression
dom-1 error MessageDefinition If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (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)

 

Other representations of profile: CSV, Excel, Schematron