NHSDigital-MessageDefinition
| Conformance url |
|---|
| https://fhir.nhs.uk/StructureDefinition/NHSDigital-MessageDefinition |
with MessageDefinition
| NHSDigitalMessageDefinition (MessageDefinition) | C | MessageDefinition | There are no (further) constraints on this element Element idMessageDefinitionShort description A resource that defines a type of message that can be exchanged between systems DefinitionDefines 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. This would be a MIF-level artifact.
| |||
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idMessageDefinition.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idMessageDefinition.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idMessageDefinition.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idMessageDefinition.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language. Binding extensions
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idMessageDefinition.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idMessageDefinition.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMessageDefinition.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idMessageDefinition.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idMessageDefinition.urlShort description Business Identifier for a given MessageDefinition DefinitionThe business identifier that is used to reference the MessageDefinition and is expected to be consistent from server to server. Allows the message definition to be referenced by a single globally unique identifier. 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. 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 element to indicate where the current master source of the resource can be found. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idMessageDefinition.identifierShort description Primary key for the message definition on a given server DefinitionA 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. Allows externally provided and/or usable business identifiers to be easily associated with the module. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this message definition outside of FHIR, where it is not possible to use the logical URI. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idMessageDefinition.versionShort description Business version of the message definition DefinitionThe 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. 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 cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| name | Σ C | 0..1 | string | There are no (further) constraints on this element Element idMessageDefinition.nameShort description Name for this message definition (computer friendly) DefinitionA 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. Support human navigation and code generation. 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. The cardinality or value of this element may be affected by these constraints: ele-1, inv-0 Constraints
| ||
| title | Σ | 0..1 | string | There are no (further) constraints on this element Element idMessageDefinition.titleShort description Name for this message definition (human friendly) DefinitionA short, descriptive, user-friendly title for the message definition. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| replaces | Σ | 0..* | canonical(MessageDefinition) | There are no (further) constraints on this element Element idMessageDefinition.replacesShort description Takes the place of DefinitionA MessageDefinition that is superseded by this definition. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idMessageDefinition.statusShort description draft | active | retired | unknown DefinitionThe status of this message definition. Enables tracking the life-cycle of the content. Allows filtering of message definitions that are appropriate for use versus not. The lifecycle status of an artifact. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| experimental | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idMessageDefinition.experimentalShort description For testing purposes, not real usage DefinitionA Boolean value to indicate that this message definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Enables experimental content to be developed following the same lifecycle that would be used for a production-level message definition. Allows filtering of message definitions that are appropriate for use versus not. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| date | Σ | 1..1 | dateTime | There are no (further) constraints on this element Element idMessageDefinition.dateShort description Date last changed Alternate namesRevision Date DefinitionThe 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| publisher | Σ | 0..1 | string | There are no (further) constraints on this element Element idMessageDefinition.publisherShort description Name of the publisher (organization or individual) DefinitionThe name of the organization or individual that published the message definition. Helps establish the "authority/credibility" of the message definition. May also allow for contact. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| contact | Σ | 0..* | ContactDetail | There are no (further) constraints on this element Element idMessageDefinition.contactShort description Contact details for the publisher DefinitionContact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| description | S Σ | 1..1 | markdown | There are no (further) constraints on this element Element idMessageDefinition.descriptionShort description Natural language description of the message definition DefinitionA free text natural language description of the message definition from a consumer's perspective. 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). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| useContext | Σ | 0..* | UsageContext | There are no (further) constraints on this element Element idMessageDefinition.useContextShort description The context that the content is intended to support DefinitionThe 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. Assist in searching for appropriate content. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idMessageDefinition.useContext.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMessageDefinition.useContext.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 1..1 | CodingBinding | Element idMessageDefinition.useContext.codeShort description Type of context being specified DefinitionA code that identifies the type of context being specified by this usage context. Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. A code that specifies a type of context being specified by a usage context. BARS Usage Context Type (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| value[x] | Σ | 1..1 | There are no (further) constraints on this element Element idMessageDefinition.useContext.value[x]Short description Value that defines the context DefinitionA value that defines the context specified in this context of use. The interpretation of the value is defined by the code. A code that defines the specific value for the context being specified. Context of Use ValueSet (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||||
| valueQuantity | Quantity | There are no (further) constraints on this element Data type | ||||
| valueRange | Range | There are no (further) constraints on this element Data type | ||||
| valueReference | Reference(Group | HealthcareService | InsurancePlan | Location | Organization | PlanDefinition | ResearchStudy) | There are no (further) constraints on this element Data typeReference(Group | HealthcareService | InsurancePlan | Location | Organization | PlanDefinition | ResearchStudy) | ||||
| jurisdiction | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idMessageDefinition.jurisdictionShort description Intended jurisdiction for message definition (if applicable) DefinitionA legal or geographic region in which the message definition is intended to be used. It may be possible for the message definition to be used in jurisdictions other than those for which it was originally designed or intended. Countries and regions within which this artifact is targeted for use. Jurisdiction ValueSet (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| purpose | Σ | 0..1 | markdown | There are no (further) constraints on this element Element idMessageDefinition.purposeShort description Why this message definition is defined DefinitionExplanation of why this message definition is needed and why it has been designed as it has. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| copyright | 0..1 | markdown | There are no (further) constraints on this element Element idMessageDefinition.copyrightShort description Use and/or publishing restrictions Alternate namesLicense, Restrictions DefinitionA copyright statement relating to the message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message definition. Consumers must be able to determine any legal restrictions on the use of the message definition and/or its content. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| base | Σ | 0..1 | canonical(MessageDefinition) | There are no (further) constraints on this element Element idMessageDefinition.baseShort description Definition this one is based on DefinitionThe MessageDefinition that is the basis for the contents of this resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| parent | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | There are no (further) constraints on this element Element idMessageDefinition.parentShort description Protocol/workflow this is part of DefinitionIdentifies a protocol or workflow that this MessageDefinition represents a step in. 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. canonical(ActivityDefinition | PlanDefinition) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| event[x] | S Σ | 1..1 | Binding | Element idMessageDefinition.event[x]Short description Event code or link to the EventDefinition DefinitionEvent code or link to the EventDefinition. One of the message events defined as part of this version of FHIR. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| eventCoding | Coding | Data type | ||||
| category | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idMessageDefinition.categoryShort description consequence | currency | notification DefinitionThe impact of the content of the message. Note that FHIR strings SHALL NOT exceed 1MB in size The impact of the content of a message. MessageSignificanceCategory (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| focus | S Σ C | 1..* | BackboneElement | There are no (further) constraints on this element Element idMessageDefinition.focusShort description Resource(s) that are the subject of the event DefinitionIdentifies 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idMessageDefinition.focus.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMessageDefinition.focus.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idMessageDefinition.focus.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idMessageDefinition.focus.codeShort description Type of resource DefinitionThe kind of resource that must be the focus for this message. Multiple focuses addressing different resources may occasionally occur. E.g. to link or unlink a resource from a particular account or encounter, etc. One of the resource types defined as part of this version of FHIR. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| profile | 0..1 | canonical(StructureDefinition) | There are no (further) constraints on this element Element idMessageDefinition.focus.profileShort description Profile that must be adhered to by focus DefinitionA profile that reflects constraints for the focal resource (and potentially for related resources). 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. 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. canonical(StructureDefinition) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| min | Σ | 1..1 | unsignedInt | There are no (further) constraints on this element Element idMessageDefinition.focus.minShort description Minimum number of focuses of this type DefinitionIdentifies 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. 32 bit number; for values larger than this, use decimal The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| max | C | 0..1 | string | There are no (further) constraints on this element Element idMessageDefinition.focus.maxShort description Maximum number of focuses of this type DefinitionIdentifies 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. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1, md-1 Constraints
| ||
| responseRequired | 0..1 | codeBinding | There are no (further) constraints on this element Element idMessageDefinition.responseRequiredShort description always | on-error | never | on-success DefinitionDeclare at a message definition level whether a response is required or only upon error or success, or never. 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. HL7-defined table of codes which identify conditions under which acknowledgments are required to be returned in response to a message. messageheader-response-request (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General alwaysMappings
| |||
| allowedResponse | 0..* | BackboneElement | There are no (further) constraints on this element Element idMessageDefinition.allowedResponseShort description Responses to this message DefinitionIndicates what types of messages may be sent as an application-level response to this message. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idMessageDefinition.allowedResponse.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMessageDefinition.allowedResponse.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idMessageDefinition.allowedResponse.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| message | 1..1 | canonical(MessageDefinition) | There are no (further) constraints on this element Element idMessageDefinition.allowedResponse.messageShort description Reference to allowed message definition response DefinitionA reference to the message definition that must be adhered to by this supported response. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| situation | 0..1 | markdown | There are no (further) constraints on this element Element idMessageDefinition.allowedResponse.situationShort description When should this response be used DefinitionProvides a description of the circumstances in which this response should be used (as opposed to one of the alternative responses). Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| graph | 0..* | canonical(GraphDefinition) | There are no (further) constraints on this element Element idMessageDefinition.graphShort description Canonical reference to a GraphDefinition DefinitionCanonical 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
from MessageDefinition
| NHSDigitalMessageDefinition (MessageDefinition) | C | MessageDefinition | There are no (further) constraints on this element Element idMessageDefinitionShort description A resource that defines a type of message that can be exchanged between systems DefinitionDefines 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. This would be a MIF-level artifact.
| |||
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idMessageDefinition.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idMessageDefinition.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idMessageDefinition.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idMessageDefinition.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language. Binding extensions
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idMessageDefinition.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idMessageDefinition.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMessageDefinition.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idMessageDefinition.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idMessageDefinition.urlShort description Business Identifier for a given MessageDefinition DefinitionThe business identifier that is used to reference the MessageDefinition and is expected to be consistent from server to server. Allows the message definition to be referenced by a single globally unique identifier. 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. 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 element to indicate where the current master source of the resource can be found. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idMessageDefinition.identifierShort description Primary key for the message definition on a given server DefinitionA 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. Allows externally provided and/or usable business identifiers to be easily associated with the module. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this message definition outside of FHIR, where it is not possible to use the logical URI. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idMessageDefinition.versionShort description Business version of the message definition DefinitionThe 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. 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 cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| name | Σ C | 0..1 | string | There are no (further) constraints on this element Element idMessageDefinition.nameShort description Name for this message definition (computer friendly) DefinitionA 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. Support human navigation and code generation. 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. The cardinality or value of this element may be affected by these constraints: ele-1, inv-0 Constraints
| ||
| title | Σ | 0..1 | string | There are no (further) constraints on this element Element idMessageDefinition.titleShort description Name for this message definition (human friendly) DefinitionA short, descriptive, user-friendly title for the message definition. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| replaces | Σ | 0..* | canonical(MessageDefinition) | There are no (further) constraints on this element Element idMessageDefinition.replacesShort description Takes the place of DefinitionA MessageDefinition that is superseded by this definition. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idMessageDefinition.statusShort description draft | active | retired | unknown DefinitionThe status of this message definition. Enables tracking the life-cycle of the content. Allows filtering of message definitions that are appropriate for use versus not. The lifecycle status of an artifact. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| experimental | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idMessageDefinition.experimentalShort description For testing purposes, not real usage DefinitionA Boolean value to indicate that this message definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Enables experimental content to be developed following the same lifecycle that would be used for a production-level message definition. Allows filtering of message definitions that are appropriate for use versus not. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| date | Σ | 1..1 | dateTime | There are no (further) constraints on this element Element idMessageDefinition.dateShort description Date last changed Alternate namesRevision Date DefinitionThe 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| publisher | Σ | 0..1 | string | There are no (further) constraints on this element Element idMessageDefinition.publisherShort description Name of the publisher (organization or individual) DefinitionThe name of the organization or individual that published the message definition. Helps establish the "authority/credibility" of the message definition. May also allow for contact. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| contact | Σ | 0..* | ContactDetail | There are no (further) constraints on this element Element idMessageDefinition.contactShort description Contact details for the publisher DefinitionContact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| description | S Σ | 1..1 | markdown | There are no (further) constraints on this element Element idMessageDefinition.descriptionShort description Natural language description of the message definition DefinitionA free text natural language description of the message definition from a consumer's perspective. 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). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| useContext | Σ | 0..* | UsageContext | There are no (further) constraints on this element Element idMessageDefinition.useContextShort description The context that the content is intended to support DefinitionThe 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. Assist in searching for appropriate content. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idMessageDefinition.useContext.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMessageDefinition.useContext.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 1..1 | CodingBinding | Element idMessageDefinition.useContext.codeShort description Type of context being specified DefinitionA code that identifies the type of context being specified by this usage context. Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. A code that specifies a type of context being specified by a usage context. BARS Usage Context Type (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| value[x] | Σ | 1..1 | There are no (further) constraints on this element Element idMessageDefinition.useContext.value[x]Short description Value that defines the context DefinitionA value that defines the context specified in this context of use. The interpretation of the value is defined by the code. A code that defines the specific value for the context being specified. Context of Use ValueSet (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||||
| valueQuantity | Quantity | There are no (further) constraints on this element Data type | ||||
| valueRange | Range | There are no (further) constraints on this element Data type | ||||
| valueReference | Reference(Group | HealthcareService | InsurancePlan | Location | Organization | PlanDefinition | ResearchStudy) | There are no (further) constraints on this element Data typeReference(Group | HealthcareService | InsurancePlan | Location | Organization | PlanDefinition | ResearchStudy) | ||||
| jurisdiction | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idMessageDefinition.jurisdictionShort description Intended jurisdiction for message definition (if applicable) DefinitionA legal or geographic region in which the message definition is intended to be used. It may be possible for the message definition to be used in jurisdictions other than those for which it was originally designed or intended. Countries and regions within which this artifact is targeted for use. Jurisdiction ValueSet (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| purpose | Σ | 0..1 | markdown | There are no (further) constraints on this element Element idMessageDefinition.purposeShort description Why this message definition is defined DefinitionExplanation of why this message definition is needed and why it has been designed as it has. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| copyright | 0..1 | markdown | There are no (further) constraints on this element Element idMessageDefinition.copyrightShort description Use and/or publishing restrictions Alternate namesLicense, Restrictions DefinitionA copyright statement relating to the message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message definition. Consumers must be able to determine any legal restrictions on the use of the message definition and/or its content. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| base | Σ | 0..1 | canonical(MessageDefinition) | There are no (further) constraints on this element Element idMessageDefinition.baseShort description Definition this one is based on DefinitionThe MessageDefinition that is the basis for the contents of this resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| parent | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | There are no (further) constraints on this element Element idMessageDefinition.parentShort description Protocol/workflow this is part of DefinitionIdentifies a protocol or workflow that this MessageDefinition represents a step in. 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. canonical(ActivityDefinition | PlanDefinition) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| event[x] | S Σ | 1..1 | Binding | Element idMessageDefinition.event[x]Short description Event code or link to the EventDefinition DefinitionEvent code or link to the EventDefinition. One of the message events defined as part of this version of FHIR. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| eventCoding | Coding | Data type | ||||
| category | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idMessageDefinition.categoryShort description consequence | currency | notification DefinitionThe impact of the content of the message. Note that FHIR strings SHALL NOT exceed 1MB in size The impact of the content of a message. MessageSignificanceCategory (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| focus | S Σ C | 1..* | BackboneElement | There are no (further) constraints on this element Element idMessageDefinition.focusShort description Resource(s) that are the subject of the event DefinitionIdentifies 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idMessageDefinition.focus.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMessageDefinition.focus.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idMessageDefinition.focus.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idMessageDefinition.focus.codeShort description Type of resource DefinitionThe kind of resource that must be the focus for this message. Multiple focuses addressing different resources may occasionally occur. E.g. to link or unlink a resource from a particular account or encounter, etc. One of the resource types defined as part of this version of FHIR. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| profile | 0..1 | canonical(StructureDefinition) | There are no (further) constraints on this element Element idMessageDefinition.focus.profileShort description Profile that must be adhered to by focus DefinitionA profile that reflects constraints for the focal resource (and potentially for related resources). 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. 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. canonical(StructureDefinition) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| min | Σ | 1..1 | unsignedInt | There are no (further) constraints on this element Element idMessageDefinition.focus.minShort description Minimum number of focuses of this type DefinitionIdentifies 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. 32 bit number; for values larger than this, use decimal The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| max | C | 0..1 | string | There are no (further) constraints on this element Element idMessageDefinition.focus.maxShort description Maximum number of focuses of this type DefinitionIdentifies 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. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1, md-1 Constraints
| ||
| responseRequired | 0..1 | codeBinding | There are no (further) constraints on this element Element idMessageDefinition.responseRequiredShort description always | on-error | never | on-success DefinitionDeclare at a message definition level whether a response is required or only upon error or success, or never. 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. HL7-defined table of codes which identify conditions under which acknowledgments are required to be returned in response to a message. messageheader-response-request (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General alwaysMappings
| |||
| allowedResponse | 0..* | BackboneElement | There are no (further) constraints on this element Element idMessageDefinition.allowedResponseShort description Responses to this message DefinitionIndicates what types of messages may be sent as an application-level response to this message. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idMessageDefinition.allowedResponse.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMessageDefinition.allowedResponse.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idMessageDefinition.allowedResponse.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| message | 1..1 | canonical(MessageDefinition) | There are no (further) constraints on this element Element idMessageDefinition.allowedResponse.messageShort description Reference to allowed message definition response DefinitionA reference to the message definition that must be adhered to by this supported response. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| situation | 0..1 | markdown | There are no (further) constraints on this element Element idMessageDefinition.allowedResponse.situationShort description When should this response be used DefinitionProvides a description of the circumstances in which this response should be used (as opposed to one of the alternative responses). Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| graph | 0..* | canonical(GraphDefinition) | There are no (further) constraints on this element Element idMessageDefinition.graphShort description Canonical reference to a GraphDefinition DefinitionCanonical 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
None Defined