Left: | Message definition for messaging order-catalog content (http://hl7.org/fhir/uv/order-catalog/StructureDefinition/CatalogMessageDefinition) |
Right: | Message definition for messaging order-catalog content (http://hl7.org/fhir/uv/order-catalog/StructureDefinition/CatalogMessageDefinition) |
Error | StructureDefinition.version | Values for version differ: '0.1.0' vs 'current' |
Warning | StructureDefinition.fhirVersion | Values for fhirVersion differ: '4.0.1' vs '5.0.0' |
Warning | MessageDefinition.id | Elements differ in comments: 'The only time that a resource does not have an id is when it is being submitted to the server using a create operation.' vs 'Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.' |
Warning | MessageDefinition.implicitRules | Elements differ in comments: 'Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.' vs 'Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.' |
Warning | MessageDefinition.language | Elements differ in binding.description: 'A human language.' vs 'IETF language tag for a human language' |
Warning | MessageDefinition.text | Elements differ in comments: 'Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a 'text blob' or where text is additionally entered raw or narrated and encoded information is added later.' vs 'Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a 'text blob' or where text is additionally entered raw or narrated and encoded information is added later.' |
Warning | MessageDefinition.contained | Elements differ in definition: 'These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.' vs 'These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.' |
Warning | MessageDefinition.extension | Elements differ in definition: 'May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.' vs 'May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.' |
Warning | MessageDefinition.modifierExtension | Elements differ in definition: 'May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).' vs 'May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).' |
Warning | MessageDefinition.url | Elements differ in short: 'Business Identifier for a given MessageDefinition' vs 'The cannonical URL for a given MessageDefinition' |
Warning | MessageDefinition.identifier | Elements differ in short: 'Primary key for the message definition on a given server' vs 'Business Identifier for a given MessageDefinition' |
Warning | MessageDefinition.version | Elements differ in comments: '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].' vs '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].' |
Warning | MessageDefinition.status | Elements differ in comments: 'Allows filtering of message definitions that are appropriate for use versus not.' vs 'Allows filtering of message definitions that are appropriate for use versus not. See guidance around (not) making local changes to elements [here].' |
Warning | MessageDefinition.date | Elements differ in definition: 'The date (and optionally time) when the message definition was published. 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.' vs '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.' |
Warning | MessageDefinition.date | Elements differ in comments: '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.' vs '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].' |
Warning | MessageDefinition.publisher | Elements differ in short: 'Name of the publisher (organization or individual)' vs 'Name of the publisher/steward (organization or individual)' |
Warning | MessageDefinition.publisher | Elements differ in definition: 'The name of the organization or individual that published the message definition.' vs 'The name of the organization or individual responsible for the release and ongoing maintenance of the message definition.' |
Warning | MessageDefinition.contact | Elements differ in comments: 'May be a web site, an email address, a telephone number, etc.' vs 'May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements [here].' |
Warning | MessageDefinition.description | Elements differ in comments: 'This description can be used to capture details such as why the message definition was built, 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).' vs '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).' |
Warning | MessageDefinition.jurisdiction | Elements differ in comments: 'It may be possible for the message definition to be used in jurisdictions other than those for which it was originally designed or intended.' vs 'It may be possible for the message definition to be used in jurisdictions other than those for which it was originally designed or intended. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)' |
Warning | MessageDefinition.focus.extension | Elements differ in definition: 'May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.' vs 'May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.' |
Warning | MessageDefinition.focus.modifierExtension | Elements differ in definition: 'May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).' vs 'May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).' |
Warning | MessageDefinition.responseRequired | Elements differ in description: 'HL7-defined table of codes which identify conditions under which acknowledgments are required to be returned in response to a message.' vs '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.' |
Warning | MessageDefinition.responseRequired | Elements differ in description: 'HL7-defined table of codes which identify conditions under which acknowledgments are required to be returned in response to a message.' vs '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.' |
Warning | MessageDefinition.allowedResponse.extension | Elements differ in definition: 'May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.' vs 'May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.' |
Warning | MessageDefinition.allowedResponse.modifierExtension | Elements differ in definition: 'May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).' vs 'May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).' |
Warning | MessageDefinition.graph | Elements differ in definition: 'Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a [GraphDefinition] that it controls what resources are to be added to the bundle when building the document. The GraphDefinition can also specify profiles that apply to the various resources.' vs 'Graph is Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a GraphDefinition that it controls what additional resources are to be added to the Bundle when building the message. The GraphDefinition can also specify profiles that apply to the various resources.' |
Information | MessageDefinition.graph | Element maximum cardinalities differ: '2147483647' vs '1' |
Name | Value | Comments | |
---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/fhir/StructureDefinition/MessageDefinition | ||
copyright | |||
date | 2020-04-02 | ||
description | This profile constrains MessageDefinition in the context of messaging the content of catalogs, in conformance with the FHIR messaging framework | ||
experimental | |||
fhirVersion | 4.0.1 | 5.0.0 |
|
jurisdiction | |||
jurisdiction[0] | http://unstats.un.org/unsd/methods/m49/m49.htm#001 | ||
kind | resource | ||
name | CatalogMessageDefinition | ||
publisher | HL7 International - Orders and Observations Work Group | ||
purpose | This profile specifies the event codes that are available for messaging the content of catalogs between a system owning a catalog and a system interested in the catalog content, in whole or in part. | ||
status | draft | ||
title | Message definition for messaging order-catalog content | ||
type | MessageDefinition | ||
url | http://hl7.org/fhir/uv/order-catalog/StructureDefinition/CatalogMessageDefinition | ||
version | 0.1.0 | current |
|
Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | L Type | L Description & Constraints | Comments | ||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
MessageDefinition | C | 0..* | MessageDefinition | A resource that defines a type of message that can be exchanged between systems | C | 0..* | MessageDefinition | A resource that defines a type of message that can be exchanged between systems | |||||
id | Σ | 0..1 | string | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact |
| ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| ||||
language | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (required): IETF language tag for a human language |
| ||||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| ||||||
contained | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources |
| ||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations |
| ||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| ||||
url | Σ | 0..1 | uri | Business Identifier for a given MessageDefinition | ΣC | 0..1 | uri | The cannonical URL for a given MessageDefinition |
| ||||
identifier | Σ | 0..* | Identifier | Primary key for the message definition on a given server | Σ | 0..* | Identifier | Business Identifier for a given MessageDefinition |
| ||||
version | Σ | 0..1 | string | Business version of the message definition | Σ | 0..1 | string | Business version of the message definition |
| ||||
name | ΣC | 0..1 | string | Name for this message definition (computer friendly) | ΣC | 0..1 | string | Name for this message definition (computer friendly) | |||||
title | Σ | 0..1 | string | Name for this message definition (human friendly) | Σ | 0..1 | string | Name for this message definition (human friendly) | |||||
replaces | Σ | 0..* | canonical(MessageDefinition) | Takes the place of | Σ | 0..* | canonical(MessageDefinition) | Takes the place of | |||||
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: ?? (required): The lifecycle status of an artifact. | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: ?? (required): The lifecycle status of an artifact. |
| ||||
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage | Σ | 0..1 | boolean | For testing purposes, not real usage | |||||
date | Σ | 1..1 | dateTime | Date last changed | Σ | 1..1 | dateTime | Date last changed |
| ||||
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) | Σ | 0..1 | string | Name of the publisher/steward (organization or individual) |
| ||||
contact | Σ | 0..* | ContactDetail | Contact details for the publisher | Σ | 0..* | ContactDetail | Contact details for the publisher |
| ||||
description | Σ | 0..1 | markdown | Natural language description of the message definition | Σ | 0..1 | markdown | Natural language description of the message definition |
| ||||
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support | Σ | 0..* | UsageContext | The context that the content is intended to support | |||||
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for message definition (if applicable) Binding: ?? (extensible): Countries and regions within which this artifact is targeted for use. | ΣXD | 0..* | CodeableConcept | Intended jurisdiction for message definition (if applicable) Binding: ?? (extensible): Countries and regions within which this artifact is targeted for use. |
| ||||
purpose | Σ | 0..1 | markdown | Why this message definition is defined | Σ | 0..1 | markdown | Why this message definition is defined | |||||
copyright | 0..1 | markdown | Use and/or publishing restrictions | 0..1 | markdown | Use and/or publishing restrictions | |||||||
base | Σ | 0..1 | canonical(MessageDefinition) | Definition this one is based on | Σ | 0..1 | canonical(MessageDefinition) | Definition this one is based on | |||||
parent | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Protocol/workflow this is part of | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Protocol/workflow this is part of | |||||
event[x] | SΣ | 1..1 | Coding | Event code Binding: ?? (extensible): message events for messages conveying order-catalog content | SΣ | 1..1 | Coding | Event code Binding: ?? (extensible): message events for messages conveying order-catalog content | |||||
category | Σ | 0..1 | code | consequence | currency | notification Binding: ?? (required): The impact of the content of a message. Fixed Value: consequence | Σ | 0..1 | code | consequence | currency | notification Binding: ?? (required): The impact of the content of a message. Fixed Value: consequence | |||||
focus | ΣC | 0..* | BackboneElement | Resource(s) that are the subject of the event md-1: Max must be postive int or * | ΣC | 0..* | BackboneElement | Resource(s) that are the subject of the event | |||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations |
| ||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| ||||
code | Σ | 1..1 | code | Type of resource Binding: ?? (required): One of the resource types defined as part of this version of FHIR. | Σ | 1..1 | code | Type of resource Binding: ?? (required): One of the resource types defined as part of this version of FHIR. | |||||
profile | 0..1 | canonical(StructureDefinition) | Profile that must be adhered to by focus | 0..1 | canonical(StructureDefinition) | Profile that must be adhered to by focus | |||||||
min | Σ | 1..1 | unsignedInt | Minimum number of focuses of this type | Σ | 1..1 | unsignedInt | Minimum number of focuses of this type | |||||
max | C | 0..1 | string | Maximum number of focuses of this type | C | 0..1 | string | Maximum number of focuses of this type | |||||
responseRequired | S | 1..1 | code | always | on-error | never | on-success Binding: ?? (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 | S | 1..1 | code | always | on-error | never | on-success Binding: ?? (required): This enables the capability currently available through MSH-16 (Application Level acknowledgement) in HL7 Version 2 to declare at a message definition level whether a response is required or only upon error or success, or never. Example General: always |
| ||||
allowedResponse | 0..* | BackboneElement | Responses to this message | 0..* | BackboneElement | Responses to this message | |||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations |
| ||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| ||||
message | 1..1 | canonical(MessageDefinition) | Reference to allowed message definition response | 1..1 | canonical(MessageDefinition) | Reference to allowed message definition response | |||||||
situation | 0..1 | markdown | When should this response be used | 0..1 | markdown | When should this response be used | |||||||
graph | 0..* | canonical(GraphDefinition) | Canonical reference to a GraphDefinition | 0..1 | canonical(GraphDefinition) | Canonical reference to a GraphDefinition |
| ||||||
versionAlgorithm[x] | Σ | 0..1 | string, Coding | How to compare versions Binding: ?? (extensible) |
| ||||||||
copyrightLabel | 0..1 | string | Copyright holder and year(s) |
| |||||||||
Documentation for this format |