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 Publishable MessageDefinition

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

Supports declaration of the MessageDefinition metadata required by HL7 and other organizations that share and publish message definitions with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.

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, pub-1
MessageDefinition.meta This element is included in summaries. 0..1 Meta Metadata about the resource
MessageDefinition.meta.Slices for extension Content/Rules for all slices
MessageDefinition.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
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:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
MessageDefinition.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
MessageDefinition.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
MessageDefinition.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
MessageDefinition.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
MessageDefinition.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
MessageDefinition.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
MessageDefinition.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
MessageDefinition.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
MessageDefinition.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
MessageDefinition.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
MessageDefinition.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
MessageDefinition.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
MessageDefinition.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
MessageDefinition.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
MessageDefinition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
MessageDefinition.identifier This element must be supported. This element is included in summaries. 0..* Identifier Primary key for the message definition on a given server
MessageDefinition.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
MessageDefinition.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
MessageDefinition.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
MessageDefinition.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
MessageDefinition.jurisdiction This element must be supported. 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 must be supported. This element is included in summaries. 0..1 markdown Why this message definition is defined
MessageDefinition.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
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.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍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.

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}')
pub-1 error MessageDefinition If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').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: pub-1
MessageDefinition.meta
MessageDefinition.meta.Slices for extension Content/Rules for all slices
MessageDefinition.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
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:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
MessageDefinition.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
MessageDefinition.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
MessageDefinition.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
MessageDefinition.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
MessageDefinition.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
MessageDefinition.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
MessageDefinition.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
MessageDefinition.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
MessageDefinition.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
MessageDefinition.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x]
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
MessageDefinition.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
MessageDefinition.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
MessageDefinition.identifier This element must be supported. 0..* Identifier Primary key for the message definition on a given server
MessageDefinition.contact This element must be supported. 0..* ContactDetail Contact details for the publisher
MessageDefinition.useContext This element must be supported. 0..* UsageContext The context that the content is intended to support
MessageDefinition.jurisdiction This element must be supported. 0..* CodeableConcept Intended jurisdiction for message definition (if applicable)
MessageDefinition.purpose This element must be supported. 0..1 markdown Why this message definition is defined
MessageDefinition.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
pub-1 error MessageDefinition If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').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, pub-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.meta.id 0..1 string Unique id for inter-element referencing
MessageDefinition.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MessageDefinition.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
MessageDefinition.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
MessageDefinition.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
MessageDefinition.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
MessageDefinition.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
MessageDefinition.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
MessageDefinition.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
MessageDefinition.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
MessageDefinition.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
MessageDefinition.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
MessageDefinition.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
MessageDefinition.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
MessageDefinition.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
MessageDefinition.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
MessageDefinition.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
MessageDefinition.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
MessageDefinition.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
MessageDefinition.Slices for extension.extension:relatedArtifact.id 0..1 string Unique id for inter-element referencing
MessageDefinition.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
MessageDefinition.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].id 0..1 string Unique id for inter-element referencing
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].label This element is included in summaries. 0..1 string Short label
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].display This element is included in summaries. 0..1 string Brief description of the related artifact
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].citation This element is included in summaries. 0..1 markdown Bibliographic citation for the artifact
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].url This element is included in summaries. 0..1 url Where the artifact can be accessed
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].document This element is included in summaries. 0..1 Attachment What document is being referenced
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].resource This element is included in summaries. 0..1 canonical(Resource) What resource is being referenced
MessageDefinition.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
MessageDefinition.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
MessageDefinition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
MessageDefinition.url This element is included in summaries. 0..1 uri Business Identifier for a given MessageDefinition
MessageDefinition.identifier This element must be supported. This element is included in summaries. 0..* Identifier Primary key for the message definition on a given server
MessageDefinition.version This element is included in summaries. 0..1 string Business version of the message definition
MessageDefinition.name This element is included in summaries. C 0..1 string Name for this message definition (computer friendly)
MessageDefinition.title This element is included in summaries. 0..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 is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
MessageDefinition.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
MessageDefinition.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
MessageDefinition.publisher This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
MessageDefinition.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
MessageDefinition.description This element is included in summaries. 0..1 markdown Natural language description of the message definition
MessageDefinition.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
MessageDefinition.jurisdiction This element must be supported. 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 must be supported. This element is included in summaries. 0..1 markdown Why this message definition is defined
MessageDefinition.copyright This element must be supported. 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.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
MessageDefinition.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
MessageDefinition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
MessageDefinition.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍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}')
pub-1 error MessageDefinition If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').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, pub-1
MessageDefinition.meta This element is included in summaries. 0..1 Meta Metadata about the resource
MessageDefinition.meta.Slices for extension Content/Rules for all slices
MessageDefinition.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
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:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
MessageDefinition.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
MessageDefinition.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
MessageDefinition.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
MessageDefinition.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
MessageDefinition.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
MessageDefinition.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
MessageDefinition.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
MessageDefinition.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
MessageDefinition.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
MessageDefinition.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
MessageDefinition.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
MessageDefinition.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
MessageDefinition.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
MessageDefinition.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
MessageDefinition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
MessageDefinition.identifier This element must be supported. This element is included in summaries. 0..* Identifier Primary key for the message definition on a given server
MessageDefinition.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
MessageDefinition.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
MessageDefinition.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
MessageDefinition.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
MessageDefinition.jurisdiction This element must be supported. 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 must be supported. This element is included in summaries. 0..1 markdown Why this message definition is defined
MessageDefinition.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
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.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍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.

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}')
pub-1 error MessageDefinition If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').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: pub-1
MessageDefinition.meta
MessageDefinition.meta.Slices for extension Content/Rules for all slices
MessageDefinition.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
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:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
MessageDefinition.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
MessageDefinition.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
MessageDefinition.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
MessageDefinition.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
MessageDefinition.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
MessageDefinition.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
MessageDefinition.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
MessageDefinition.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
MessageDefinition.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
MessageDefinition.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x]
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
MessageDefinition.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
MessageDefinition.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
MessageDefinition.identifier This element must be supported. 0..* Identifier Primary key for the message definition on a given server
MessageDefinition.date This element must be supported. 1..1 dateTime Date last changed
MessageDefinition.contact This element must be supported. 0..* ContactDetail Contact details for the publisher
MessageDefinition.useContext This element must be supported. 0..* UsageContext The context that the content is intended to support
MessageDefinition.jurisdiction This element must be supported. 0..* CodeableConcept Intended jurisdiction for message definition (if applicable)
MessageDefinition.purpose This element must be supported. 0..1 markdown Why this message definition is defined
MessageDefinition.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
pub-1 error MessageDefinition If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').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, pub-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.meta.id 0..1 string Unique id for inter-element referencing
MessageDefinition.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MessageDefinition.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
MessageDefinition.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
MessageDefinition.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
MessageDefinition.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
MessageDefinition.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
MessageDefinition.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
MessageDefinition.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
MessageDefinition.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
MessageDefinition.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
MessageDefinition.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
MessageDefinition.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
MessageDefinition.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
MessageDefinition.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
MessageDefinition.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
MessageDefinition.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
MessageDefinition.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
MessageDefinition.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
MessageDefinition.Slices for extension.extension:relatedArtifact.id 0..1 string Unique id for inter-element referencing
MessageDefinition.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
MessageDefinition.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].id 0..1 string Unique id for inter-element referencing
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].label This element is included in summaries. 0..1 string Short label
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].display This element is included in summaries. 0..1 string Brief description of the related artifact
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].citation This element is included in summaries. 0..1 markdown Bibliographic citation for the artifact
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].url This element is included in summaries. 0..1 url Where the artifact can be accessed
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].document This element is included in summaries. 0..1 Attachment What document is being referenced
MessageDefinition.Slices for extension.extension:relatedArtifact.value[x].resource This element is included in summaries. 0..1 canonical(Resource) What resource is being referenced
MessageDefinition.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
MessageDefinition.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
MessageDefinition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
MessageDefinition.url This element is included in summaries. 0..1 uri Business Identifier for a given MessageDefinition
MessageDefinition.identifier This element must be supported. This element is included in summaries. 0..* Identifier Primary key for the message definition on a given server
MessageDefinition.version This element is included in summaries. 0..1 string Business version of the message definition
MessageDefinition.name This element is included in summaries. C 0..1 string Name for this message definition (computer friendly)
MessageDefinition.title This element is included in summaries. 0..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 is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
MessageDefinition.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
MessageDefinition.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
MessageDefinition.publisher This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
MessageDefinition.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
MessageDefinition.description This element is included in summaries. 0..1 markdown Natural language description of the message definition
MessageDefinition.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
MessageDefinition.jurisdiction This element must be supported. 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 must be supported. This element is included in summaries. 0..1 markdown Why this message definition is defined
MessageDefinition.copyright This element must be supported. 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.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
MessageDefinition.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
MessageDefinition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
MessageDefinition.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍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}')
pub-1 error MessageDefinition If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

 

Other representations of profile: CSV, Excel, Schematron