diff --git a/source/messagedefinition/bundle-MessageDefinition-search-params.xml b/source/messagedefinition/bundle-MessageDefinition-search-params.xml index b64db38d9e..ac655f9872 100644 --- a/source/messagedefinition/bundle-MessageDefinition-search-params.xml +++ b/source/messagedefinition/bundle-MessageDefinition-search-params.xml @@ -357,12 +357,12 @@ - - - + + + diff --git a/source/messagedefinition/messagedefinition-definition-mapping-exceptions.xml b/source/messagedefinition/messagedefinition-definition-mapping-exceptions.xml index d3bef0f810..be58910806 100644 --- a/source/messagedefinition/messagedefinition-definition-mapping-exceptions.xml +++ b/source/messagedefinition/messagedefinition-definition-mapping-exceptions.xml @@ -3,7 +3,7 @@ <_pattern value="Canonical identifier for this message definition, represented as an absolute URI (globally unique)"/> - + <_pattern value="An absolute URI that is used to identify this message definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this message definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the message definition is stored on different servers."/> diff --git a/source/messagedefinition/structuredefinition-MessageDefinition.xml b/source/messagedefinition/structuredefinition-MessageDefinition.xml index 11aaa0694b..adb7a73d23 100644 --- a/source/messagedefinition/structuredefinition-MessageDefinition.xml +++ b/source/messagedefinition/structuredefinition-MessageDefinition.xml @@ -1,719 +1,723 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - <status value="draft"/> - <date value="2021-01-05T10:01:24+11:00"/> - <publisher value="HL7 International / Infrastructure And Messaging"/> - <contact> - <telecom> - <system value="url"/> - <value value="http://hl7.org/fhir"/> - </telecom> - </contact> - <contact> - <telecom> - <system value="url"/> - <value value="http://www.hl7.org/special/committees/inm/index.cfm"/> - </telecom> - </contact> - <description value="Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted."/> - <purpose value="Allows messages to be defined once and re-used across systems."/> - <fhirVersion value="6.0.0"/> - <mapping> - <identity value="v2"/> - <uri value="http://hl7.org/v2"/> - <name value="HL7 V2 Mapping"/> - </mapping> - <mapping> - <identity value="rim"/> - <uri value="http://hl7.org/v3"/> - <name value="RIM Mapping"/> - </mapping> - <mapping> - <identity value="w5"/> - <uri value="http://hl7.org/fhir/fivews"/> - <name value="FiveWs Pattern Mapping"/> - </mapping> - <mapping> - <identity value="workflow"/> - <uri value="http://hl7.org/fhir/workflow"/> - <name value="Workflow Pattern"/> - </mapping> - <mapping> - <identity value="objimpl"/> - <uri value="http://hl7.org/fhir/object-implementation"/> - <name value="Object Implementation Information"/> - </mapping> - <kind value="resource"/> - <abstract value="false"/> - <type value="MessageDefinition"/> - <baseDefinition value="http://hl7.org/fhir/StructureDefinition/CanonicalResource"/> - <derivation value="specialization"/> - <differential> - <element id="MessageDefinition"> - <extension url="http://hl7.org/fhir/build/StructureDefinition/svg"> - <valueCode value="0,0"/> - </extension> - <path value="MessageDefinition"/> - <short value="A resource that defines a type of message that can be exchanged between systems"/> - <definition value="Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted."/> - <comment value="This would be a MIF-level artifact."/> - <min value="0"/> - <max value="*"/> - <constraint> - <key value="cnl-0"/> - <severity value="warning"/> - <human value="Name should be usable as an identifier for the module by machine processing applications such as code generation"/> - <expression value="name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')"/> - <source value="http://hl7.org/fhir/StructureDefinition/MessageDefinition"/> - </constraint> - <mapping> - <identity value="workflow"/> - <map value="Definition"/> - </mapping> - <mapping> - <identity value="v2"/> - <map value="N/A"/> - </mapping> - <mapping> - <identity value="rim"/> - <map value="N/A"/> - </mapping> - <mapping> - <identity value="w5"/> - <map value="infrastructure.exchange"/> - </mapping> - </element> - <element id="MessageDefinition.url"> - <path value="MessageDefinition.url"/> - <short value="The cannonical URL for a given MessageDefinition"/> - <definition value="The business identifier that is used to reference the MessageDefinition and *is* expected to be consistent from server to server."/> - <comment value="Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found."/> - <requirements value="Allows the message definition to be referenced by a single globally unique identifier."/> - <min value="0"/> - <max value="1"/> - <type> - <code value="uri"/> - </type> - <constraint> - <key value="cnl-1"/> - <severity value="warning"/> - <human value="URL should not contain | or # - these characters make processing canonical references problematic"/> - <expression value="exists() implies matches('^[^|# ]+$')"/> - <source value="http://hl7.org/fhir/StructureDefinition/CanonicalResource"/> - </constraint> - <isSummary value="true"/> - <mapping> - <identity value="workflow"/> - <map value="Definition.url"/> - </mapping> - <mapping> - <identity value="w5"/> - <map value="FiveWs.identifier"/> - </mapping> - </element> - <element id="MessageDefinition.identifier"> - <path value="MessageDefinition.identifier"/> - <short value="Business Identifier for a given MessageDefinition"/> - <definition value="A formal identifier that is used to identify this message definition when it is represented in other formats, or referenced in a specification, model, design or an instance."/> - <requirements value="Allows externally provided and/or usable business identifiers to be easily associated with the module."/> - <min value="0"/> - <max value="*"/> - <type> - <code value="Identifier"/> - </type> - <isSummary value="true"/> - <mapping> - <identity value="workflow"/> - <map value="Definition.identifier"/> - </mapping> - <mapping> - <identity value="w5"/> - <map value="FiveWs.identifier"/> - </mapping> - <mapping> - <identity value="objimpl"/> - <map value="no-gen-base"/> - </mapping> - </element> - <element id="MessageDefinition.version"> - <path value="MessageDefinition.version"/> - <short value="Business version of the message definition"/> - <definition value="The identifier that is used to identify this version of the message definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the message definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence."/> - <comment value="There may be different message definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the message definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format)."/> - <min value="0"/> - <max value="1"/> - <type> - <code value="string"/> - </type> - <isSummary value="true"/> - <mapping> - <identity value="workflow"/> - <map value="Definition.version"/> - </mapping> - <mapping> - <identity value="w5"/> - <map value="FiveWs.version"/> - </mapping> - </element> - <element id="MessageDefinition.versionAlgorithm[x]"> - <path value="MessageDefinition.versionAlgorithm[x]"/> - <short value="How to compare versions"/> - <definition value="Indicates the mechanism used to compare versions to determine which is more current."/> - <comment value="If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined."/> - <min value="0"/> - <max value="1"/> - <type> - <code value="string"/> - </type> - <type> - <code value="Coding"/> - </type> - <isSummary value="true"/> - <binding> - <strength value="extensible"/> - <valueSet value="http://hl7.org/fhir/ValueSet/version-algorithm"/> - </binding> - </element> - <element id="MessageDefinition.name"> - <path value="MessageDefinition.name"/> - <short value="Name for this message definition (computer friendly)"/> - <definition value="A natural language name identifying the message definition. This name should be usable as an identifier for the module by machine processing applications such as code generation."/> - <comment value="The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly."/> - <requirements value="Support human navigation and code generation."/> - <min value="0"/> - <max value="1"/> - <type> - <code value="string"/> - </type> - <condition value="cnl-0"/> - <isSummary value="true"/> - <mapping> - <identity value="workflow"/> - <map value="Definition.name"/> - </mapping> - </element> - <element id="MessageDefinition.title"> - <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable"> - <valueBoolean value="true"/> - </extension> - <path value="MessageDefinition.title"/> - <short value="Name for this message definition (human friendly)"/> - <definition value="A short, descriptive, user-friendly title for the message definition."/> - <comment value="This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc."/> - <min value="0"/> - <max value="1"/> - <type> - <code value="string"/> - </type> - <isSummary value="true"/> - <mapping> - <identity value="workflow"/> - <map value="Definition.title"/> - </mapping> - </element> - <element id="MessageDefinition.replaces"> - <path value="MessageDefinition.replaces"/> - <short value="Takes the place of"/> - <definition value="A MessageDefinition that is superseded by this definition."/> - <min value="0"/> - <max value="*"/> - <type> - <code value="canonical"/> - <targetProfile value="http://hl7.org/fhir/StructureDefinition/MessageDefinition"/> - </type> - <isSummary value="true"/> - </element> - <element id="MessageDefinition.status"> - <path value="MessageDefinition.status"/> - <short value="draft | active | retired | unknown"/> - <definition value="The status of this message definition. Enables tracking the life-cycle of the content."/> - <comment value="Allows filtering of message definitions that are appropriate for use versus not. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization)."/> - <min value="1"/> - <max value="1"/> - <type> - <code value="code"/> - </type> - <isModifier value="true"/> - <isModifierReason value="This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration"/> - <isSummary value="true"/> - <binding> - <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> - <valueString value="PublicationStatus"/> - </extension> - <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> - <valueBoolean value="true"/> - </extension> - <strength value="required"/> - <description value="The lifecycle status of an artifact."/> - <valueSet value="http://hl7.org/fhir/ValueSet/publication-status"/> - </binding> - <mapping> - <identity value="workflow"/> - <map value="Definition.status"/> - </mapping> - <mapping> - <identity value="w5"/> - <map value="FiveWs.status"/> - </mapping> - </element> - <element id="MessageDefinition.experimental"> - <path value="MessageDefinition.experimental"/> - <short value="For testing only - never for real usage"/> - <definition value="A Boolean value to indicate that this message definition is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage."/> - <comment value="Allows filtering of message definitions that are appropriate for use versus not. Experimental resources might include example instances in implementation guides, instances created solely for testing purposes, etc. If experimental is 'true' for any version of a resource, it should be true for all versions of the resource. (If experimental changes, then it is being misused or a resource that was never intended for real-world use has unexpectedly changed its purpose.). Experimental resources are not expected to be stable and may well have breaking changes without a corresponding change to the 'version' element."/> - <requirements value="Enables experimental content to be developed following the same lifecycle that would be used for a production-level message definition."/> - <min value="0"/> - <max value="1"/> - <type> - <code value="boolean"/> - </type> - <meaningWhenMissing value="If absent, this resource is treated as though it is not experimental."/> - <isSummary value="true"/> - <mapping> - <identity value="workflow"/> - <map value="Definition.experimental"/> - </mapping> - <mapping> - <identity value="w5"/> - <map value="FiveWs.class"/> - </mapping> - </element> - <element id="MessageDefinition.date"> - <path value="MessageDefinition.date"/> - <short value="Date last changed"/> - <definition value="The date (and optionally time) when the message definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the message definition changes."/> - <comment value="The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the message definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization)."/> - <alias value="Revision Date"/> - <min value="1"/> - <max value="1"/> - <type> - <code value="dateTime"/> - </type> - <isSummary value="true"/> - <mapping> - <identity value="workflow"/> - <map value="Definition.date"/> - </mapping> - <mapping> - <identity value="w5"/> - <map value="FiveWs.recorded"/> - </mapping> - </element> - <element id="MessageDefinition.publisher"> - <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable"> - <valueBoolean value="true"/> - </extension> - <path value="MessageDefinition.publisher"/> - <short value="Name of the publisher/steward (organization or individual)"/> - <definition value="The name of the organization or individual responsible for the release and ongoing maintenance of the message definition."/> - <comment value="Usually an organization but may be an individual. The publisher (or steward) of the message definition is the organization or individual primarily responsible for the maintenance and upkeep of the message definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the message definition. This item SHOULD be populated unless the information is available from context."/> - <requirements value="Helps establish the "authority/credibility" of the message definition. May also allow for contact."/> - <min value="0"/> - <max value="1"/> - <type> - <code value="string"/> - </type> - <isSummary value="true"/> - <mapping> - <identity value="workflow"/> - <map value="Definition.publisher"/> - </mapping> - <mapping> - <identity value="w5"/> - <map value="FiveWs.witness"/> - </mapping> - </element> - <element id="MessageDefinition.contact"> - <path value="MessageDefinition.contact"/> - <short value="Contact details for the publisher"/> - <definition value="Contact details to assist a user in finding and communicating with the publisher."/> - <comment value="May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization)."/> - <min value="0"/> - <max value="*"/> - <type> - <code value="ContactDetail"/> - </type> - <isSummary value="true"/> - <mapping> - <identity value="workflow"/> - <map value="Definition.contact"/> - </mapping> - </element> - <element id="MessageDefinition.description"> - <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable"> - <valueBoolean value="true"/> - </extension> - <path value="MessageDefinition.description"/> - <short value="Natural language description of the message definition"/> - <definition value="A free text natural language description of the message definition from a consumer's perspective."/> - <comment value="This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the message definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the message definition is presumed to be the predominant language in the place the message definition was created)."/> - <min value="0"/> - <max value="1"/> - <type> - <code value="markdown"/> - </type> - <isSummary value="true"/> - <mapping> - <identity value="workflow"/> - <map value="Definition.description"/> - </mapping> - </element> - <element id="MessageDefinition.useContext"> - <path value="MessageDefinition.useContext"/> - <short value="The context that the content is intended to support"/> - <definition value="The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate message definition instances."/> - <comment value="When multiple useContexts are specified, there is no expectation that all or any of the contexts apply."/> - <requirements value="Assist in searching for appropriate content."/> - <min value="0"/> - <max value="*"/> - <type> - <code value="UsageContext"/> - </type> - <isSummary value="true"/> - <mapping> - <identity value="workflow"/> - <map value="Definition.useContext"/> - </mapping> - </element> - <element id="MessageDefinition.jurisdiction"> - <path value="MessageDefinition.jurisdiction"/> - <short value="Jurisdiction of the authority that maintains the message definition (if applicable)"/> - <definition value="A legal or geographic region in which the authority that maintains the resource is operating. In general, the jurisdiction is also found in the useContext. The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of use."/> - <comment value="It may be possible for the message definition to be used in jurisdictions other than those for which it was originally designed or intended."/> - <min value="0"/> - <max value="*"/> - <type> - <code value="CodeableConcept"/> - </type> - <isSummary value="true"/> - <binding> - <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> - <valueString value="Jurisdiction"/> - </extension> - <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> - <valueBoolean value="true"/> - </extension> - <strength value="extensible"/> - <description value="Countries and regions within which this artifact is targeted for use."/> - <valueSet value="http://terminology.hl7.org/ValueSet/jurisdiction"/> - </binding> - <mapping> - <identity value="workflow"/> - <map value="Definition.jurisdiction"/> - </mapping> - </element> - <element id="MessageDefinition.purpose"> - <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable"> - <valueBoolean value="true"/> - </extension> - <path value="MessageDefinition.purpose"/> - <short value="Why this message definition is defined"/> - <definition value="Explanation of why this message definition is needed and why it has been designed as it has."/> - <comment value="This element does not describe the usage of the message definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this message definition."/> - <min value="0"/> - <max value="1"/> - <type> - <code value="markdown"/> - </type> - <isSummary value="true"/> - <mapping> - <identity value="workflow"/> - <map value="Definition.purpose"/> - </mapping> - <mapping> - <identity value="w5"/> - <map value="FiveWs.why[x]"/> - </mapping> - <mapping> - <identity value="objimpl"/> - <map value="no-gen-base"/> - </mapping> - </element> - <element id="MessageDefinition.copyright"> - <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable"> - <valueBoolean value="true"/> - </extension> - <path value="MessageDefinition.copyright"/> - <short value="Notice about intellectual property ownership, can include restrictions on use"/> - <definition value="A copyright statement relating to the message definition and/or its contents. Copyright statements are notices of intellectual property ownership and can include restrictions on the use and publishing of the message definition."/> - <requirements value="Consumers must be able to determine any legal restrictions on the use of the message definition and/or its content."/> - <alias value="License"/> - <alias value="Restrictions"/> - <min value="0"/> - <max value="1"/> - <type> - <code value="markdown"/> - </type> - <mapping> - <identity value="workflow"/> - <map value="Definition.copyright"/> - </mapping> - <mapping> - <identity value="objimpl"/> - <map value="no-gen-base"/> - </mapping> - </element> - <element id="MessageDefinition.copyrightLabel"> - <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable"> - <valueBoolean value="true"/> - </extension> - <path value="MessageDefinition.copyrightLabel"/> - <short value="Copyright holder and year(s)"/> - <definition value="A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are restricted. (e.g. 'All rights reserved', 'Some rights reserved')."/> - <comment value="The copyright symbol and the '(c)' textual representation SHOULD NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element."/> - <requirements value="Defines the content expected to be rendered in all representations of the artifact."/> - <min value="0"/> - <max value="1"/> - <type> - <code value="string"/> - </type> - </element> - <element id="MessageDefinition.base"> - <path value="MessageDefinition.base"/> - <short value="Definition this one is based on"/> - <definition value="The MessageDefinition that is the basis for the contents of this resource."/> - <min value="0"/> - <max value="1"/> - <type> - <code value="canonical"/> - <targetProfile value="http://hl7.org/fhir/StructureDefinition/MessageDefinition"/> - </type> - <isSummary value="true"/> - </element> - <element id="MessageDefinition.parent"> - <path value="MessageDefinition.parent"/> - <short value="Protocol/workflow this is part of"/> - <definition value="Identifies a protocol or workflow that this MessageDefinition represents a step in."/> - <comment value="It should be possible to use MessageDefinition to describe a message to be used by certain steps in a particular protocol as part of a PlanDefinition or ActivityDefinition."/> - <min value="0"/> - <max value="*"/> - <type> - <code value="canonical"/> - <targetProfile value="http://hl7.org/fhir/StructureDefinition/ActivityDefinition"/> - <targetProfile value="http://hl7.org/fhir/StructureDefinition/PlanDefinition"/> - </type> - <isSummary value="true"/> - </element> - <element id="MessageDefinition.event[x]"> - <path value="MessageDefinition.event[x]"/> - <short value="Event code or link to the EventDefinition"/> - <definition value="Event code or link to the EventDefinition."/> - <min value="1"/> - <max value="1"/> - <type> - <code value="Coding"/> - </type> - <type> - <code value="uri"/> - </type> - <isSummary value="true"/> - <binding> - <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> - <valueString value="MessageEvent"/> - </extension> - <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> - <valueBoolean value="true"/> - </extension> - <strength value="example"/> - <description value="One of the message events defined as part of this version of FHIR."/> - <valueSet value="http://hl7.org/fhir/ValueSet/message-events"/> - </binding> - </element> - <element id="MessageDefinition.category"> - <path value="MessageDefinition.category"/> - <short value="consequence | currency | notification"/> - <definition value="The impact of the content of the message."/> - <min value="0"/> - <max value="1"/> - <type> - <code value="code"/> - </type> - <isSummary value="true"/> - <binding> - <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> - <valueString value="MessageSignificanceCategory"/> - </extension> - <strength value="required"/> - <description value="The impact of the content of a message."/> - <valueSet value="http://hl7.org/fhir/ValueSet/message-significance-category"/> - </binding> - </element> - <element id="MessageDefinition.focus"> - <extension url="http://hl7.org/fhir/build/StructureDefinition/svg"> - <valueCode value="410,0"/> - </extension> - <path value="MessageDefinition.focus"/> - <short value="Resource(s) that are the subject of the event"/> - <definition value="Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge."/> - <min value="0"/> - <max value="*"/> - <type> - <code value="BackboneElement"/> - </type> - <constraint> - <key value="md-1"/> - <severity value="error"/> - <human value="Max must be postive int or *"/> - <expression value="max='*' or (max.toInteger() > 0)"/> - <source value="http://hl7.org/fhir/StructureDefinition/MessageDefinition"/> - </constraint> - <isSummary value="true"/> - </element> - <element id="MessageDefinition.focus.code"> - <path value="MessageDefinition.focus.code"/> - <short value="Type of resource"/> - <definition value="The kind of resource that must be the focus for this message. This must be a resource, or a type with a [[[http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics]]] of [[[http://hl7.org/fhir/type-characteristics-code#can-be-target]]]."/> - <comment value="Multiple focuses addressing different resources may occasionally occur. E.g. to link or unlink a resource from a particular account or encounter, etc."/> - <min value="1"/> - <max value="1"/> - <type> - <code value="uri"/> - </type> - <isSummary value="true"/> - <binding> - <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> - <valueString value="FHIRTypes"/> - </extension> - <extension url="http://hl7.org/fhir/build/StructureDefinition/copyright"> - <valueString value="FHIR"/> - </extension> - <strength value="extensible"/> - <description value="Either a resource or a data type, including logical model types."/> - <valueSet value="http://hl7.org/fhir/ValueSet/version-independent-resource-types"/> - </binding> - </element> - <element id="MessageDefinition.focus.profile"> - <path value="MessageDefinition.focus.profile"/> - <short value="Profile that must be adhered to by focus"/> - <definition value="A profile that reflects constraints for the focal resource (and potentially for related resources)."/> - <comment value="This should be present for most message definitions. However, if the message focus is only a single resource and there is no need to include referenced resources or otherwise enforce the presence of particular elements, it can be omitted."/> - <requirements value="This profile allows setting boundaries for what content must appear within the message bundle vs. outside based on the declared aggregation constraints on referenced resources on this and related profiles."/> - <min value="0"/> - <max value="1"/> - <type> - <code value="canonical"/> - <targetProfile value="http://hl7.org/fhir/StructureDefinition/StructureDefinition"/> - </type> - </element> - <element id="MessageDefinition.focus.min"> - <path value="MessageDefinition.focus.min"/> - <short value="Minimum number of focuses of this type"/> - <definition value="Identifies the minimum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition."/> - <min value="1"/> - <max value="1"/> - <type> - <code value="unsignedInt"/> - </type> - <isSummary value="true"/> - </element> - <element id="MessageDefinition.focus.max"> - <path value="MessageDefinition.focus.max"/> - <short value="Maximum number of focuses of this type"/> - <definition value="Identifies the maximum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition."/> - <min value="0"/> - <max value="1"/> - <type> - <code value="string"/> - </type> - <condition value="md-1"/> - </element> - <element id="MessageDefinition.responseRequired"> - <path value="MessageDefinition.responseRequired"/> - <short value="always | on-error | never | on-success"/> - <definition value="Declare at a message definition level whether a response is required or only upon error or success, or never."/> - <comment value="This enables the capability currently available through MSH-16 (Application Level acknowledgement) in HL7 Version 2 to declare at a message instance level whether a response is required or only upon error or success, or never."/> - <min value="0"/> - <max value="1"/> - <type> - <code value="code"/> - </type> - <example> - <label value="General"/> - <valueCode value="always"/> - </example> - <binding> - <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> - <valueString value="messageheader-response-request"/> - </extension> - <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> - <valueString value="HL7-defined table of codes which identify conditions under which acknowledgments are required to be returned in response to a message."/> - </extension> - <strength value="required"/> - <description value="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."/> - <valueSet value="http://hl7.org/fhir/ValueSet/messageheader-response-request"/> - </binding> - <mapping> - <identity value="v2"/> - <map value="MSH-16"/> - </mapping> - </element> - <element id="MessageDefinition.allowedResponse"> - <extension url="http://hl7.org/fhir/build/StructureDefinition/svg"> - <valueCode value="410,250"/> - </extension> - <path value="MessageDefinition.allowedResponse"/> - <short value="Responses to this message"/> - <definition value="Indicates what types of messages may be sent as an application-level response to this message."/> - <comment value="This indicates an application level response to "close" a transaction implicit in a particular request message. To define a complete workflow scenario, look to the [[PlanDefinition]] resource which allows the definition of complex orchestrations, conditionality, etc."/> - <min value="0"/> - <max value="*"/> - <type> - <code value="BackboneElement"/> - </type> - </element> - <element id="MessageDefinition.allowedResponse.message"> - <path value="MessageDefinition.allowedResponse.message"/> - <short value="Reference to allowed message definition response"/> - <definition value="A reference to the message definition that must be adhered to by this supported response."/> - <min value="1"/> - <max value="1"/> - <type> - <code value="canonical"/> - <targetProfile value="http://hl7.org/fhir/StructureDefinition/MessageDefinition"/> - </type> - </element> - <element id="MessageDefinition.allowedResponse.situation"> - <path value="MessageDefinition.allowedResponse.situation"/> - <short value="When should this response be used"/> - <definition value="Provides a description of the circumstances in which this response should be used (as opposed to one of the alternative responses)."/> - <min value="0"/> - <max value="1"/> - <type> - <code value="markdown"/> - </type> - </element> - </differential> + +<StructureDefinition xmlns="http://hl7.org/fhir" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://hl7.org/fhir ../../publish/StructureDefinition.xsd"> + <id value="MessageDefinition"/> + <meta> + <lastUpdated value="2021-01-05T10:01:24.148+11:00"/> + </meta> + <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-category"> + <valueString value="Foundation.Conformance"/> + </extension> + <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> + <valueCode value="normative"/> + </extension> + <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"> + <valueInteger value="1"/> + </extension> + <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category"> + <valueCode value="anonymous"/> + </extension> + <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"> + <valueCode value="inm"/> + </extension> + <extension url="http://hl7.org/fhir/build/StructureDefinition/entered-in-error-status"> + <valueCode value="mostly n/a, but in the cases where messages are stored in error, they would simply be deleted"/> + </extension> + <extension url="http://hl7.org/fhir/build/StructureDefinition/template"> + <valueString value="CanonicalResource"/> + </extension> + <url value="http://hl7.org/fhir/StructureDefinition/MessageDefinition"/> + <identifier> + <system value="urn:ietf:rfc:3986"/> + <value value="urn:oid:2.16.840.1.113883.4.642.5.1117"/> + </identifier> + <version value="6.0.0"/> + <name value="MessageDefinition"/> + <title value="Message Definition"/> + <status value="draft"/> + <date value="2021-01-05T10:01:24+11:00"/> + <publisher value="HL7 International / Infrastructure And Messaging"/> + <contact> + <telecom> + <system value="url"/> + <value value="http://hl7.org/fhir"/> + </telecom> + </contact> + <contact> + <telecom> + <system value="url"/> + <value value="http://www.hl7.org/special/committees/inm/index.cfm"/> + </telecom> + </contact> + <description value="Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted."/> + <purpose value="Allows messages to be defined once and re-used across systems."/> + <fhirVersion value="6.0.0"/> + <mapping> + <identity value="v2"/> + <uri value="http://hl7.org/v2"/> + <name value="HL7 V2 Mapping"/> + </mapping> + <mapping> + <identity value="rim"/> + <uri value="http://hl7.org/v3"/> + <name value="RIM Mapping"/> + </mapping> + <mapping> + <identity value="w5"/> + <uri value="http://hl7.org/fhir/fivews"/> + <name value="FiveWs Pattern Mapping"/> + </mapping> + <mapping> + <identity value="workflow"/> + <uri value="http://hl7.org/fhir/workflow"/> + <name value="Workflow Pattern"/> + </mapping> + <mapping> + <identity value="objimpl"/> + <uri value="http://hl7.org/fhir/object-implementation"/> + <name value="Object Implementation Information"/> + </mapping> + <kind value="resource"/> + <abstract value="false"/> + <type value="MessageDefinition"/> + <baseDefinition value="http://hl7.org/fhir/StructureDefinition/CanonicalResource"/> + <derivation value="specialization"/> + <differential> + <element id="MessageDefinition"> + <extension url="http://hl7.org/fhir/build/StructureDefinition/svg"> + <valueCode value="0,0"/> + </extension> + <path value="MessageDefinition"/> + <short value="A resource that defines a type of message that can be exchanged between systems"/> + <definition value="Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted."/> + <comment value="This would be a MIF-level artifact."/> + <min value="0"/> + <max value="*"/> + <constraint> + <key value="cnl-0"/> + <severity value="warning"/> + <human value="Name should be usable as an identifier for the module by machine processing applications such as code generation"/> + <expression value="name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')"/> + <source value="http://hl7.org/fhir/StructureDefinition/MessageDefinition"/> + </constraint> + <mapping> + <identity value="workflow"/> + <map value="Definition"/> + </mapping> + <mapping> + <identity value="v2"/> + <map value="N/A"/> + </mapping> + <mapping> + <identity value="rim"/> + <map value="N/A"/> + </mapping> + <mapping> + <identity value="w5"/> + <map value="infrastructure.exchange"/> + </mapping> + </element> + <element id="MessageDefinition.url"> + <path value="MessageDefinition.url"/> + <short value="The cannonical URL for a given MessageDefinition + Warning: URL SHOULD not contain | or # - these characters make processing canonical references problematic"/> + <definition value="The business identifier that is used to reference the MessageDefinition and *is* expected to be consistent from server to server."/> + <comment value="Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found."/> + <requirements value="Allows the message definition to be referenced by a single globally unique identifier."/> + <min value="0"/> + <max value="1"/> + <type> + <code value="uri"/> + </type> + <constraint> + <key value="cnl-1"/> + <severity value="warning"/> + <human value="URL should not contain | or # - these characters make processing canonical references problematic"/> + <expression value="exists() implies matches('^[^|# ]+$')"/> + <source value="http://hl7.org/fhir/StructureDefinition/CanonicalResource"/> + </constraint> + <isSummary value="true"/> + <mapping> + <identity value="workflow"/> + <map value="Definition.url"/> + </mapping> + <mapping> + <identity value="w5"/> + <map value="FiveWs.identifier"/> + </mapping> + </element> + <element id="MessageDefinition.identifier"> + <path value="MessageDefinition.identifier"/> + <short value="Business Identifier for a given MessageDefinition"/> + <definition value="A formal identifier that is used to identify this message definition when it is represented in other formats, or referenced in a specification, model, design or an instance."/> + <requirements value="Allows externally provided and/or usable business identifiers to be easily associated with the module."/> + <min value="0"/> + <max value="*"/> + <type> + <code value="Identifier"/> + </type> + <isSummary value="true"/> + <mapping> + <identity value="workflow"/> + <map value="Definition.identifier"/> + </mapping> + <mapping> + <identity value="w5"/> + <map value="FiveWs.identifier"/> + </mapping> + <mapping> + <identity value="objimpl"/> + <map value="no-gen-base"/> + </mapping> + </element> + <element id="MessageDefinition.version"> + <path value="MessageDefinition.version"/> + <short value="Business version of the message definition"/> + <definition value="The identifier that is used to identify this version of the message definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the message definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence."/> + <comment value="There may be different message definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the message definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format)."/> + <min value="0"/> + <max value="1"/> + <type> + <code value="string"/> + </type> + <isSummary value="true"/> + <mapping> + <identity value="workflow"/> + <map value="Definition.version"/> + </mapping> + <mapping> + <identity value="w5"/> + <map value="FiveWs.version"/> + </mapping> + </element> + <element id="MessageDefinition.versionAlgorithm[x]"> + <path value="MessageDefinition.versionAlgorithm[x]"/> + <short value="How to compare versions"/> + <definition value="Indicates the mechanism used to compare versions to determine which is more current."/> + <comment value="If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined."/> + <min value="0"/> + <max value="1"/> + <type> + <code value="string"/> + </type> + <type> + <code value="Coding"/> + </type> + <isSummary value="true"/> + <binding> + <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> + <valueString value="??"/> + </extension> + <strength value="extensible"/> + <valueSet value="http://hl7.org/fhir/ValueSet/version-algorithm"/> + </binding> + </element> + <element id="MessageDefinition.name"> + <path value="MessageDefinition.name"/> + <short value="Name for this message definition (computer friendly)"/> + <definition value="A natural language name identifying the message definition. This name should be usable as an identifier for the module by machine processing applications such as code generation."/> + <comment value="The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly."/> + <requirements value="Support human navigation and code generation."/> + <min value="0"/> + <max value="1"/> + <type> + <code value="string"/> + </type> + <condition value="cnl-0"/> + <isSummary value="true"/> + <mapping> + <identity value="workflow"/> + <map value="Definition.name"/> + </mapping> + </element> + <element id="MessageDefinition.title"> + <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable"> + <valueBoolean value="true"/> + </extension> + <path value="MessageDefinition.title"/> + <short value="Name for this message definition (human friendly)"/> + <definition value="A short, descriptive, user-friendly title for the message definition."/> + <comment value="This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc."/> + <min value="0"/> + <max value="1"/> + <type> + <code value="string"/> + </type> + <isSummary value="true"/> + <mapping> + <identity value="workflow"/> + <map value="Definition.title"/> + </mapping> + </element> + <element id="MessageDefinition.replaces"> + <path value="MessageDefinition.replaces"/> + <short value="Takes the place of"/> + <definition value="A MessageDefinition that is superseded by this definition."/> + <min value="0"/> + <max value="*"/> + <type> + <code value="canonical"/> + <targetProfile value="http://hl7.org/fhir/StructureDefinition/MessageDefinition"/> + </type> + <isSummary value="true"/> + </element> + <element id="MessageDefinition.status"> + <path value="MessageDefinition.status"/> + <short value="draft | active | retired | unknown"/> + <definition value="The status of this message definition. Enables tracking the life-cycle of the content."/> + <comment value="Allows filtering of message definitions that are appropriate for use versus not. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization)."/> + <min value="1"/> + <max value="1"/> + <type> + <code value="code"/> + </type> + <isModifier value="true"/> + <isModifierReason value="This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration"/> + <isSummary value="true"/> + <binding> + <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> + <valueString value="PublicationStatus"/> + </extension> + <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> + <valueBoolean value="true"/> + </extension> + <strength value="required"/> + <description value="The lifecycle status of an artifact."/> + <valueSet value="http://hl7.org/fhir/ValueSet/publication-status"/> + </binding> + <mapping> + <identity value="workflow"/> + <map value="Definition.status"/> + </mapping> + <mapping> + <identity value="w5"/> + <map value="FiveWs.status"/> + </mapping> + </element> + <element id="MessageDefinition.experimental"> + <path value="MessageDefinition.experimental"/> + <short value="For testing only - never for real usage"/> + <definition value="A Boolean value to indicate that this message definition is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage."/> + <comment value="Allows filtering of message definitions that are appropriate for use versus not. Experimental resources might include example instances in implementation guides, instances created solely for testing purposes, etc. If experimental is 'true' for any version of a resource, it should be true for all versions of the resource. (If experimental changes, then it is being misused or a resource that was never intended for real-world use has unexpectedly changed its purpose.). Experimental resources are not expected to be stable and may well have breaking changes without a corresponding change to the 'version' element."/> + <requirements value="Enables experimental content to be developed following the same lifecycle that would be used for a production-level message definition."/> + <min value="0"/> + <max value="1"/> + <type> + <code value="boolean"/> + </type> + <meaningWhenMissing value="If absent, this resource is treated as though it is not experimental."/> + <isSummary value="true"/> + <mapping> + <identity value="workflow"/> + <map value="Definition.experimental"/> + </mapping> + <mapping> + <identity value="w5"/> + <map value="FiveWs.class"/> + </mapping> + </element> + <element id="MessageDefinition.date"> + <path value="MessageDefinition.date"/> + <short value="Date last changed"/> + <definition value="The date (and optionally time) when the message definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the message definition changes."/> + <comment value="The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the message definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization)."/> + <alias value="Revision Date"/> + <min value="1"/> + <max value="1"/> + <type> + <code value="dateTime"/> + </type> + <isSummary value="true"/> + <mapping> + <identity value="workflow"/> + <map value="Definition.date"/> + </mapping> + <mapping> + <identity value="w5"/> + <map value="FiveWs.recorded"/> + </mapping> + </element> + <element id="MessageDefinition.publisher"> + <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable"> + <valueBoolean value="true"/> + </extension> + <path value="MessageDefinition.publisher"/> + <short value="Name of the publisher/steward (organization or individual)"/> + <definition value="The name of the organization or individual responsible for the release and ongoing maintenance of the message definition."/> + <comment value="Usually an organization but may be an individual. The publisher (or steward) of the message definition is the organization or individual primarily responsible for the maintenance and upkeep of the message definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the message definition. This item SHOULD be populated unless the information is available from context."/> + <requirements value="Helps establish the "authority/credibility" of the message definition. May also allow for contact."/> + <min value="0"/> + <max value="1"/> + <type> + <code value="string"/> + </type> + <isSummary value="true"/> + <mapping> + <identity value="workflow"/> + <map value="Definition.publisher"/> + </mapping> + <mapping> + <identity value="w5"/> + <map value="FiveWs.witness"/> + </mapping> + </element> + <element id="MessageDefinition.contact"> + <path value="MessageDefinition.contact"/> + <short value="Contact details for the publisher"/> + <definition value="Contact details to assist a user in finding and communicating with the publisher."/> + <comment value="May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization)."/> + <min value="0"/> + <max value="*"/> + <type> + <code value="ContactDetail"/> + </type> + <isSummary value="true"/> + <mapping> + <identity value="workflow"/> + <map value="Definition.contact"/> + </mapping> + </element> + <element id="MessageDefinition.description"> + <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable"> + <valueBoolean value="true"/> + </extension> + <path value="MessageDefinition.description"/> + <short value="Natural language description of the message definition"/> + <definition value="A free text natural language description of the message definition from a consumer's perspective."/> + <comment value="This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the message definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the message definition is presumed to be the predominant language in the place the message definition was created)."/> + <min value="0"/> + <max value="1"/> + <type> + <code value="markdown"/> + </type> + <isSummary value="true"/> + <mapping> + <identity value="workflow"/> + <map value="Definition.description"/> + </mapping> + </element> + <element id="MessageDefinition.useContext"> + <path value="MessageDefinition.useContext"/> + <short value="The context that the content is intended to support"/> + <definition value="The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate message definition instances."/> + <comment value="When multiple useContexts are specified, there is no expectation that all or any of the contexts apply."/> + <requirements value="Assist in searching for appropriate content."/> + <min value="0"/> + <max value="*"/> + <type> + <code value="UsageContext"/> + </type> + <isSummary value="true"/> + <mapping> + <identity value="workflow"/> + <map value="Definition.useContext"/> + </mapping> + </element> + <element id="MessageDefinition.jurisdiction"> + <path value="MessageDefinition.jurisdiction"/> + <short value="Jurisdiction of the authority that maintains the message definition (if applicable)"/> + <definition value="A legal or geographic region in which the authority that maintains the resource is operating. In general, the jurisdiction is also found in the useContext. The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of use."/> + <comment value="It may be possible for the message definition to be used in jurisdictions other than those for which it was originally designed or intended."/> + <min value="0"/> + <max value="*"/> + <type> + <code value="CodeableConcept"/> + </type> + <isSummary value="true"/> + <binding> + <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> + <valueString value="Jurisdiction"/> + </extension> + <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> + <valueBoolean value="true"/> + </extension> + <strength value="extensible"/> + <description value="Countries and regions within which this artifact is targeted for use."/> + <valueSet value="http://terminology.hl7.org/ValueSet/jurisdiction"/> + </binding> + <mapping> + <identity value="workflow"/> + <map value="Definition.jurisdiction"/> + </mapping> + </element> + <element id="MessageDefinition.purpose"> + <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable"> + <valueBoolean value="true"/> + </extension> + <path value="MessageDefinition.purpose"/> + <short value="Why this message definition is defined"/> + <definition value="Explanation of why this message definition is needed and why it has been designed as it has."/> + <comment value="This element does not describe the usage of the message definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this message definition."/> + <min value="0"/> + <max value="1"/> + <type> + <code value="markdown"/> + </type> + <isSummary value="true"/> + <mapping> + <identity value="workflow"/> + <map value="Definition.purpose"/> + </mapping> + <mapping> + <identity value="w5"/> + <map value="FiveWs.why[x]"/> + </mapping> + <mapping> + <identity value="objimpl"/> + <map value="no-gen-base"/> + </mapping> + </element> + <element id="MessageDefinition.copyright"> + <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable"> + <valueBoolean value="true"/> + </extension> + <path value="MessageDefinition.copyright"/> + <short value="Notice about intellectual property ownership, can include restrictions on use"/> + <definition value="A copyright statement relating to the message definition and/or its contents. Copyright statements are notices of intellectual property ownership and can include restrictions on the use and publishing of the message definition."/> + <requirements value="Consumers must be able to determine any legal restrictions on the use of the message definition and/or its content."/> + <alias value="License"/> + <alias value="Restrictions"/> + <min value="0"/> + <max value="1"/> + <type> + <code value="markdown"/> + </type> + <mapping> + <identity value="workflow"/> + <map value="Definition.copyright"/> + </mapping> + <mapping> + <identity value="objimpl"/> + <map value="no-gen-base"/> + </mapping> + </element> + <element id="MessageDefinition.copyrightLabel"> + <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable"> + <valueBoolean value="true"/> + </extension> + <path value="MessageDefinition.copyrightLabel"/> + <short value="Copyright holder and year(s)"/> + <definition value="A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are restricted. (e.g. 'All rights reserved', 'Some rights reserved')."/> + <comment value="The copyright symbol and the '(c)' textual representation SHOULD NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element."/> + <requirements value="Defines the content expected to be rendered in all representations of the artifact."/> + <min value="0"/> + <max value="1"/> + <type> + <code value="string"/> + </type> + </element> + <element id="MessageDefinition.base"> + <path value="MessageDefinition.base"/> + <short value="Definition this one is based on"/> + <definition value="The MessageDefinition that is the basis for the contents of this resource."/> + <min value="0"/> + <max value="1"/> + <type> + <code value="canonical"/> + <targetProfile value="http://hl7.org/fhir/StructureDefinition/MessageDefinition"/> + </type> + <isSummary value="true"/> + </element> + <element id="MessageDefinition.parent"> + <path value="MessageDefinition.parent"/> + <short value="Protocol/workflow this is part of"/> + <definition value="Identifies a protocol or workflow that this MessageDefinition represents a step in."/> + <comment value="It should be possible to use MessageDefinition to describe a message to be used by certain steps in a particular protocol as part of a PlanDefinition or ActivityDefinition."/> + <min value="0"/> + <max value="*"/> + <type> + <code value="canonical"/> + <targetProfile value="http://hl7.org/fhir/StructureDefinition/ActivityDefinition"/> + <targetProfile value="http://hl7.org/fhir/StructureDefinition/PlanDefinition"/> + </type> + <isSummary value="true"/> + </element> + <element id="MessageDefinition.event[x]"> + <path value="MessageDefinition.event[x]"/> + <short value="Event code or link to the EventDefinition"/> + <definition value="Event code or link to the EventDefinition."/> + <min value="1"/> + <max value="1"/> + <type> + <code value="Coding"/> + </type> + <type> + <code value="uri"/> + </type> + <isSummary value="true"/> + <binding> + <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> + <valueString value="MessageEvent"/> + </extension> + <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> + <valueBoolean value="true"/> + </extension> + <strength value="example"/> + <description value="One of the message events defined as part of this version of FHIR."/> + <valueSet value="http://hl7.org/fhir/ValueSet/message-events"/> + </binding> + </element> + <element id="MessageDefinition.category"> + <path value="MessageDefinition.category"/> + <short value="consequence | currency | notification"/> + <definition value="The impact of the content of the message."/> + <min value="0"/> + <max value="1"/> + <type> + <code value="code"/> + </type> + <isSummary value="true"/> + <binding> + <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> + <valueString value="MessageSignificanceCategory"/> + </extension> + <strength value="required"/> + <description value="The impact of the content of a message."/> + <valueSet value="http://hl7.org/fhir/ValueSet/message-significance-category"/> + </binding> + </element> + <element id="MessageDefinition.focus"> + <extension url="http://hl7.org/fhir/build/StructureDefinition/svg"> + <valueCode value="410,0"/> + </extension> + <path value="MessageDefinition.focus"/> + <short value="Resource(s) that are the subject of the event"/> + <definition value="Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge."/> + <min value="0"/> + <max value="*"/> + <type> + <code value="BackboneElement"/> + </type> + <constraint> + <key value="md-1"/> + <severity value="error"/> + <human value="Max must be postive int or *"/> + <expression value="max='*' or (max.toInteger() > 0)"/> + <source value="http://hl7.org/fhir/StructureDefinition/MessageDefinition"/> + </constraint> + <isSummary value="true"/> + </element> + <element id="MessageDefinition.focus.code"> + <path value="MessageDefinition.focus.code"/> + <short value="Type of resource"/> + <definition value="The kind of resource that must be the focus for this message. This must be a resource, or a type with a [[[http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics]]] of [[[http://hl7.org/fhir/type-characteristics-code#can-be-target]]]."/> + <comment value="Multiple focuses addressing different resources may occasionally occur. E.g. to link or unlink a resource from a particular account or encounter, etc."/> + <min value="1"/> + <max value="1"/> + <type> + <code value="uri"/> + </type> + <isSummary value="true"/> + <binding> + <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> + <valueString value="FHIRTypes"/> + </extension> + <extension url="http://hl7.org/fhir/build/StructureDefinition/copyright"> + <valueString value="FHIR"/> + </extension> + <strength value="extensible"/> + <description value="Either a resource or a data type, including logical model types."/> + <valueSet value="http://hl7.org/fhir/ValueSet/version-independent-resource-types"/> + </binding> + </element> + <element id="MessageDefinition.focus.profile"> + <path value="MessageDefinition.focus.profile"/> + <short value="Profile that must be adhered to by focus"/> + <definition value="A profile that reflects constraints for the focal resource (and potentially for related resources)."/> + <comment value="This should be present for most message definitions. However, if the message focus is only a single resource and there is no need to include referenced resources or otherwise enforce the presence of particular elements, it can be omitted."/> + <requirements value="This profile allows setting boundaries for what content must appear within the message bundle vs. outside based on the declared aggregation constraints on referenced resources on this and related profiles."/> + <min value="0"/> + <max value="1"/> + <type> + <code value="canonical"/> + <targetProfile value="http://hl7.org/fhir/StructureDefinition/StructureDefinition"/> + </type> + </element> + <element id="MessageDefinition.focus.min"> + <path value="MessageDefinition.focus.min"/> + <short value="Minimum number of focuses of this type"/> + <definition value="Identifies the minimum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition."/> + <min value="1"/> + <max value="1"/> + <type> + <code value="unsignedInt"/> + </type> + <isSummary value="true"/> + </element> + <element id="MessageDefinition.focus.max"> + <path value="MessageDefinition.focus.max"/> + <short value="Maximum number of focuses of this type"/> + <definition value="Identifies the maximum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition."/> + <min value="0"/> + <max value="1"/> + <type> + <code value="string"/> + </type> + <condition value="md-1"/> + </element> + <element id="MessageDefinition.responseRequired"> + <path value="MessageDefinition.responseRequired"/> + <short value="always | on-error | never | on-success"/> + <definition value="Declare at a message definition level whether a response is required or only upon error or success, or never."/> + <comment value="This enables the capability currently available through MSH-16 (Application Level acknowledgement) in HL7 Version 2 to declare at a message instance level whether a response is required or only upon error or success, or never."/> + <min value="0"/> + <max value="1"/> + <type> + <code value="code"/> + </type> + <example> + <label value="General"/> + <valueCode value="always"/> + </example> + <binding> + <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> + <valueString value="messageheader-response-request"/> + </extension> + <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> + <valueMarkdown value="HL7-defined table of codes which identify conditions under which acknowledgments are required to be returned in response to a message."/> + </extension> + <strength value="required"/> + <description value="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."/> + <valueSet value="http://hl7.org/fhir/ValueSet/messageheader-response-request"/> + </binding> + <mapping> + <identity value="v2"/> + <map value="MSH-16"/> + </mapping> + </element> + <element id="MessageDefinition.allowedResponse"> + <extension url="http://hl7.org/fhir/build/StructureDefinition/svg"> + <valueCode value="410,250"/> + </extension> + <path value="MessageDefinition.allowedResponse"/> + <short value="Responses to this message"/> + <definition value="Indicates what types of messages may be sent as an application-level response to this message."/> + <comment value="This indicates an application level response to "close" a transaction implicit in a particular request message. To define a complete workflow scenario, look to the [[PlanDefinition]] resource which allows the definition of complex orchestrations, conditionality, etc."/> + <min value="0"/> + <max value="*"/> + <type> + <code value="BackboneElement"/> + </type> + </element> + <element id="MessageDefinition.allowedResponse.message"> + <path value="MessageDefinition.allowedResponse.message"/> + <short value="Reference to allowed message definition response"/> + <definition value="A reference to the message definition that must be adhered to by this supported response."/> + <min value="1"/> + <max value="1"/> + <type> + <code value="canonical"/> + <targetProfile value="http://hl7.org/fhir/StructureDefinition/MessageDefinition"/> + </type> + </element> + <element id="MessageDefinition.allowedResponse.situation"> + <path value="MessageDefinition.allowedResponse.situation"/> + <short value="When should this response be used"/> + <definition value="Provides a description of the circumstances in which this response should be used (as opposed to one of the alternative responses)."/> + <min value="0"/> + <max value="1"/> + <type> + <code value="markdown"/> + </type> + </element> + </differential> </StructureDefinition> \ No newline at end of file