RLMessageHeaderControlloCoerenza
Descrizione
Di seguito è presentato il contenuto del profilo in diversi formati. La corrispondente definizione è consultabile al seguente link: RLMessageHeaderControlloCoerenza.
Snapshot View
MessageHeader | I | MessageHeader | There are no (further) constraints on this element Element IdMessageHeader A resource that describes a message that is exchanged between systems DefinitionThe header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.
| |
event[x] | Σ | 1..1 | Element IdMessageHeader.event[x] Codice identificativo della natura del messaggio DefinitionCode that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://terminology.hl7.org/CodeSystem/message-events". Alternatively uri to the EventDefinition. Drives the behavior associated with this message. The time of the event will be found in the focus resource. The time of the message will be found in Bundle.timestamp. One of the message events defined as part of this version of FHIR. MessageEvent (example)Constraints
| |
eventCoding | Coding | Data Type | ||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdMessageHeader.event[x].system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdMessageHeader.event[x].version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | Σ | 0..1 | code | Element IdMessageHeader.event[x].code Codice identificativo della natura del messaggio Definition"1" - Evento di fallimento di controlli di coerenza Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | Σ | 0..1 | string | Element IdMessageHeader.event[x].display Descrizione Definition"1" - Evento di fallimento di controlli di coerenza Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdMessageHeader.event[x].userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
destination | Σ | 0..* | BackboneElement | Element IdMessageHeader.destination Applicativo destinatario DefinitionThe destination application which the message is intended for. Indicates where message is to be sent for routing purposes. Allows verification of "am I the intended recipient". There SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.
|
name | Σ | 0..1 | string | Element IdMessageHeader.destination.name Ente erogatore DefinitionHuman-readable name for the target system. May be used for routing of response and/or to support audit. Note that FHIR strings SHALL NOT exceed 1MB in size
|
target | Σ I | 0..1 | Reference(Device) | There are no (further) constraints on this element Element IdMessageHeader.destination.target Particular delivery destination within the destination DefinitionIdentifies the target end system in situations where the initial message transmission is to an intermediary system. Supports multi-hop routing. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
endpoint | Σ | 1..1 | url | Element IdMessageHeader.destination.endpoint Endpoint applicativo destinatario DefinitionIndicates where the message should be routed to. Identifies where to route the message. The id may be a non-resolvable URI for systems that do not use standard network-based addresses.
|
receiver | Σ I | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | There are no (further) constraints on this element Element IdMessageHeader.destination.receiver Intended "real-world" recipient for the data DefinitionAllows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient. Allows routing beyond just the application level. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Practitioner | PractitionerRole | Organization) Constraints
|
sender | Σ I | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | There are no (further) constraints on this element Element IdMessageHeader.sender Real world sender of the message DefinitionIdentifies the sending system to allow the use of a trust relationship. Allows routing beyond just the application level. Use case is for where a (trusted) sending system is responsible for multiple organizations, and therefore cannot differentiate based on source endpoint / authentication alone. Reference(Practitioner | PractitionerRole | Organization) Constraints
|
enterer | Σ I | 0..1 | Reference(Practitioner | PractitionerRole) | There are no (further) constraints on this element Element IdMessageHeader.enterer The source of the data entry DefinitionThe person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions. Need to know for audit/traceback requirements and possibly for authorization. Usually only for the request but can be used in a response. Reference(Practitioner | PractitionerRole) Constraints
|
author | Σ I | 0..1 | Reference(Practitioner | PractitionerRole) | There are no (further) constraints on this element Element IdMessageHeader.author The source of the decision DefinitionThe logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions. Need to know for audit/traceback requirements and possibly for authorization. Usually only for the request but can be used in a response. Reference(Practitioner | PractitionerRole) Constraints
|
source | Σ | 1..1 | BackboneElement | Element IdMessageHeader.source Applicativo sorgente DefinitionThe source application from which this message originated. Allows replies, supports audit.
|
name | Σ | 0..1 | string | Element IdMessageHeader.source.name Server FHIR NPRI DefinitionHuman-readable name for the source system. May be used to support audit. Note that FHIR strings SHALL NOT exceed 1MB in size
|
software | Σ | 0..1 | string | There are no (further) constraints on this element Element IdMessageHeader.source.software Name of software running the system DefinitionMay include configuration or other information useful in debugging. Supports audit and possibly interface engine behavior. Note that FHIR strings SHALL NOT exceed 1MB in size
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdMessageHeader.source.version Version of software running DefinitionCan convey versions of multiple systems in situations where a message passes through multiple hands. Supports audit and possibly interface engine behavior. Note that FHIR strings SHALL NOT exceed 1MB in size
|
contact | Σ I | 0..1 | ContactPoint | There are no (further) constraints on this element Element IdMessageHeader.source.contact Human contact for problems DefinitionAn e-mail, phone, website or other contact point to use to resolve issues with message communications. Allows escalation of technical issues.
|
endpoint | Σ | 1..1 | url | Element IdMessageHeader.source.endpoint Endpoint applicativo sorgente DefinitionIdentifies the routing target to send acknowledgements to. Identifies where to send responses, may influence security permissions. The id may be a non-resolvable URI for systems that do not use standard network-based addresses.
|
responsible | Σ I | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | There are no (further) constraints on this element Element IdMessageHeader.responsible Final responsibility for event DefinitionThe person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party. Need to know for audit/traceback requirements and possibly for authorization. Usually only for the request but can be used in a response. Reference(Practitioner | PractitionerRole | Organization) Constraints
|
reason | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdMessageHeader.reason Cause of event DefinitionCoded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message. Need to be able to track why resources are being changed and report in the audit log/history of the resource. May affect authorization. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Reason for event occurrence. ExampleMessageReasonCodes (example)Constraints
|
response | Σ | 0..1 | BackboneElement | There are no (further) constraints on this element Element IdMessageHeader.response If this is a reply to prior message DefinitionInformation about the message that this message is a response to. Only present if this message is a response.
|
identifier | Σ | 1..1 | id | There are no (further) constraints on this element Element IdMessageHeader.response.identifier Id of original message DefinitionThe MessageHeader.id of the message to which this message is a response. Allows receiver to know what message is being responded to. RFC 4122
|
code | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element IdMessageHeader.response.code ok | transient-error | fatal-error DefinitionCode that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not. Allows the sender of the acknowledge message to know if the request was successful or if action is needed. This is a generic response to the request message. Specific data for the response will be found in MessageHeader.focus. The kind of response to a message. ResponseType (required)Constraints
|
details | Σ I | 0..1 | Reference(OperationOutcome) | There are no (further) constraints on this element Element IdMessageHeader.response.details Specific list of hints/warnings/errors DefinitionFull details of any issues found in the message. Allows the sender of the message to determine what the specific issues are. This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error.
|
focus | Σ I | 0..* | Reference(RLOperationOutcome) | Element IdMessageHeader.focus Codifica risposta validazione DefinitionReference al profilo RLOperationOutcome Every message event is about actual data, a single resource, that is identified in the definition of the event, and perhaps some or all linked resources. The data is defined where the transaction type is defined. The transaction data is always included in the bundle that is the full message. Only the root resource is specified. The resources it references should be contained in the bundle but are not also listed here. Multiple repetitions are allowed to cater for merges and other situations with multiple focal targets.
|
definition | Σ | 0..1 | canonical(MessageDefinition) | There are no (further) constraints on this element Element IdMessageHeader.definition Link to the definition for this message DefinitionPermanent link to the MessageDefinition for this message. Allows sender to define the expected contents of the message.
|
Differential View
MessageHeader | I | MessageHeader | There are no (further) constraints on this element Element IdMessageHeader A resource that describes a message that is exchanged between systems DefinitionThe header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.
| |
event[x] | Σ | 1..1 | Element IdMessageHeader.event[x] Codice identificativo della natura del messaggio DefinitionCode that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://terminology.hl7.org/CodeSystem/message-events". Alternatively uri to the EventDefinition. Drives the behavior associated with this message. The time of the event will be found in the focus resource. The time of the message will be found in Bundle.timestamp. One of the message events defined as part of this version of FHIR. MessageEvent (example)Constraints
| |
eventCoding | Coding | Data Type | ||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdMessageHeader.event[x].system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdMessageHeader.event[x].version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | Σ | 0..1 | code | Element IdMessageHeader.event[x].code Codice identificativo della natura del messaggio Definition"1" - Evento di fallimento di controlli di coerenza Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | Σ | 0..1 | string | Element IdMessageHeader.event[x].display Descrizione Definition"1" - Evento di fallimento di controlli di coerenza Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdMessageHeader.event[x].userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
destination | Σ | 0..* | BackboneElement | Element IdMessageHeader.destination Applicativo destinatario DefinitionThe destination application which the message is intended for. Indicates where message is to be sent for routing purposes. Allows verification of "am I the intended recipient". There SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.
|
name | Σ | 0..1 | string | Element IdMessageHeader.destination.name Ente erogatore DefinitionHuman-readable name for the target system. May be used for routing of response and/or to support audit. Note that FHIR strings SHALL NOT exceed 1MB in size
|
target | Σ I | 0..1 | Reference(Device) | There are no (further) constraints on this element Element IdMessageHeader.destination.target Particular delivery destination within the destination DefinitionIdentifies the target end system in situations where the initial message transmission is to an intermediary system. Supports multi-hop routing. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
endpoint | Σ | 1..1 | url | Element IdMessageHeader.destination.endpoint Endpoint applicativo destinatario DefinitionIndicates where the message should be routed to. Identifies where to route the message. The id may be a non-resolvable URI for systems that do not use standard network-based addresses.
|
receiver | Σ I | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | There are no (further) constraints on this element Element IdMessageHeader.destination.receiver Intended "real-world" recipient for the data DefinitionAllows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient. Allows routing beyond just the application level. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Practitioner | PractitionerRole | Organization) Constraints
|
sender | Σ I | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | There are no (further) constraints on this element Element IdMessageHeader.sender Real world sender of the message DefinitionIdentifies the sending system to allow the use of a trust relationship. Allows routing beyond just the application level. Use case is for where a (trusted) sending system is responsible for multiple organizations, and therefore cannot differentiate based on source endpoint / authentication alone. Reference(Practitioner | PractitionerRole | Organization) Constraints
|
enterer | Σ I | 0..1 | Reference(Practitioner | PractitionerRole) | There are no (further) constraints on this element Element IdMessageHeader.enterer The source of the data entry DefinitionThe person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions. Need to know for audit/traceback requirements and possibly for authorization. Usually only for the request but can be used in a response. Reference(Practitioner | PractitionerRole) Constraints
|
author | Σ I | 0..1 | Reference(Practitioner | PractitionerRole) | There are no (further) constraints on this element Element IdMessageHeader.author The source of the decision DefinitionThe logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions. Need to know for audit/traceback requirements and possibly for authorization. Usually only for the request but can be used in a response. Reference(Practitioner | PractitionerRole) Constraints
|
source | Σ | 1..1 | BackboneElement | Element IdMessageHeader.source Applicativo sorgente DefinitionThe source application from which this message originated. Allows replies, supports audit.
|
name | Σ | 0..1 | string | Element IdMessageHeader.source.name Server FHIR NPRI DefinitionHuman-readable name for the source system. May be used to support audit. Note that FHIR strings SHALL NOT exceed 1MB in size
|
software | Σ | 0..1 | string | There are no (further) constraints on this element Element IdMessageHeader.source.software Name of software running the system DefinitionMay include configuration or other information useful in debugging. Supports audit and possibly interface engine behavior. Note that FHIR strings SHALL NOT exceed 1MB in size
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdMessageHeader.source.version Version of software running DefinitionCan convey versions of multiple systems in situations where a message passes through multiple hands. Supports audit and possibly interface engine behavior. Note that FHIR strings SHALL NOT exceed 1MB in size
|
contact | Σ I | 0..1 | ContactPoint | There are no (further) constraints on this element Element IdMessageHeader.source.contact Human contact for problems DefinitionAn e-mail, phone, website or other contact point to use to resolve issues with message communications. Allows escalation of technical issues.
|
endpoint | Σ | 1..1 | url | Element IdMessageHeader.source.endpoint Endpoint applicativo sorgente DefinitionIdentifies the routing target to send acknowledgements to. Identifies where to send responses, may influence security permissions. The id may be a non-resolvable URI for systems that do not use standard network-based addresses.
|
responsible | Σ I | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | There are no (further) constraints on this element Element IdMessageHeader.responsible Final responsibility for event DefinitionThe person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party. Need to know for audit/traceback requirements and possibly for authorization. Usually only for the request but can be used in a response. Reference(Practitioner | PractitionerRole | Organization) Constraints
|
reason | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdMessageHeader.reason Cause of event DefinitionCoded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message. Need to be able to track why resources are being changed and report in the audit log/history of the resource. May affect authorization. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Reason for event occurrence. ExampleMessageReasonCodes (example)Constraints
|
response | Σ | 0..1 | BackboneElement | There are no (further) constraints on this element Element IdMessageHeader.response If this is a reply to prior message DefinitionInformation about the message that this message is a response to. Only present if this message is a response.
|
identifier | Σ | 1..1 | id | There are no (further) constraints on this element Element IdMessageHeader.response.identifier Id of original message DefinitionThe MessageHeader.id of the message to which this message is a response. Allows receiver to know what message is being responded to. RFC 4122
|
code | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element IdMessageHeader.response.code ok | transient-error | fatal-error DefinitionCode that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not. Allows the sender of the acknowledge message to know if the request was successful or if action is needed. This is a generic response to the request message. Specific data for the response will be found in MessageHeader.focus. The kind of response to a message. ResponseType (required)Constraints
|
details | Σ I | 0..1 | Reference(OperationOutcome) | There are no (further) constraints on this element Element IdMessageHeader.response.details Specific list of hints/warnings/errors DefinitionFull details of any issues found in the message. Allows the sender of the message to determine what the specific issues are. This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error.
|
focus | Σ I | 0..* | Reference(RLOperationOutcome) | Element IdMessageHeader.focus Codifica risposta validazione DefinitionReference al profilo RLOperationOutcome Every message event is about actual data, a single resource, that is identified in the definition of the event, and perhaps some or all linked resources. The data is defined where the transaction type is defined. The transaction data is always included in the bundle that is the full message. Only the root resource is specified. The resources it references should be contained in the bundle but are not also listed here. Multiple repetitions are allowed to cater for merges and other situations with multiple focal targets.
|
definition | Σ | 0..1 | canonical(MessageDefinition) | There are no (further) constraints on this element Element IdMessageHeader.definition Link to the definition for this message DefinitionPermanent link to the MessageDefinition for this message. Allows sender to define the expected contents of the message.
|
Hybrid View
MessageHeader | I | MessageHeader | There are no (further) constraints on this element Element IdMessageHeader A resource that describes a message that is exchanged between systems DefinitionThe header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.
| |
event[x] | Σ | 1..1 | Element IdMessageHeader.event[x] Codice identificativo della natura del messaggio DefinitionCode that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://terminology.hl7.org/CodeSystem/message-events". Alternatively uri to the EventDefinition. Drives the behavior associated with this message. The time of the event will be found in the focus resource. The time of the message will be found in Bundle.timestamp. One of the message events defined as part of this version of FHIR. MessageEvent (example)Constraints
| |
eventCoding | Coding | Data Type | ||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdMessageHeader.event[x].system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdMessageHeader.event[x].version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | Σ | 0..1 | code | Element IdMessageHeader.event[x].code Codice identificativo della natura del messaggio Definition"1" - Evento di fallimento di controlli di coerenza Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | Σ | 0..1 | string | Element IdMessageHeader.event[x].display Descrizione Definition"1" - Evento di fallimento di controlli di coerenza Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdMessageHeader.event[x].userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
destination | Σ | 0..* | BackboneElement | Element IdMessageHeader.destination Applicativo destinatario DefinitionThe destination application which the message is intended for. Indicates where message is to be sent for routing purposes. Allows verification of "am I the intended recipient". There SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.
|
name | Σ | 0..1 | string | Element IdMessageHeader.destination.name Ente erogatore DefinitionHuman-readable name for the target system. May be used for routing of response and/or to support audit. Note that FHIR strings SHALL NOT exceed 1MB in size
|
target | Σ I | 0..1 | Reference(Device) | There are no (further) constraints on this element Element IdMessageHeader.destination.target Particular delivery destination within the destination DefinitionIdentifies the target end system in situations where the initial message transmission is to an intermediary system. Supports multi-hop routing. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
endpoint | Σ | 1..1 | url | Element IdMessageHeader.destination.endpoint Endpoint applicativo destinatario DefinitionIndicates where the message should be routed to. Identifies where to route the message. The id may be a non-resolvable URI for systems that do not use standard network-based addresses.
|
receiver | Σ I | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | There are no (further) constraints on this element Element IdMessageHeader.destination.receiver Intended "real-world" recipient for the data DefinitionAllows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient. Allows routing beyond just the application level. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Practitioner | PractitionerRole | Organization) Constraints
|
sender | Σ I | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | There are no (further) constraints on this element Element IdMessageHeader.sender Real world sender of the message DefinitionIdentifies the sending system to allow the use of a trust relationship. Allows routing beyond just the application level. Use case is for where a (trusted) sending system is responsible for multiple organizations, and therefore cannot differentiate based on source endpoint / authentication alone. Reference(Practitioner | PractitionerRole | Organization) Constraints
|
enterer | Σ I | 0..1 | Reference(Practitioner | PractitionerRole) | There are no (further) constraints on this element Element IdMessageHeader.enterer The source of the data entry DefinitionThe person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions. Need to know for audit/traceback requirements and possibly for authorization. Usually only for the request but can be used in a response. Reference(Practitioner | PractitionerRole) Constraints
|
author | Σ I | 0..1 | Reference(Practitioner | PractitionerRole) | There are no (further) constraints on this element Element IdMessageHeader.author The source of the decision DefinitionThe logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions. Need to know for audit/traceback requirements and possibly for authorization. Usually only for the request but can be used in a response. Reference(Practitioner | PractitionerRole) Constraints
|
source | Σ | 1..1 | BackboneElement | Element IdMessageHeader.source Applicativo sorgente DefinitionThe source application from which this message originated. Allows replies, supports audit.
|
name | Σ | 0..1 | string | Element IdMessageHeader.source.name Server FHIR NPRI DefinitionHuman-readable name for the source system. May be used to support audit. Note that FHIR strings SHALL NOT exceed 1MB in size
|
software | Σ | 0..1 | string | There are no (further) constraints on this element Element IdMessageHeader.source.software Name of software running the system DefinitionMay include configuration or other information useful in debugging. Supports audit and possibly interface engine behavior. Note that FHIR strings SHALL NOT exceed 1MB in size
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdMessageHeader.source.version Version of software running DefinitionCan convey versions of multiple systems in situations where a message passes through multiple hands. Supports audit and possibly interface engine behavior. Note that FHIR strings SHALL NOT exceed 1MB in size
|
contact | Σ I | 0..1 | ContactPoint | There are no (further) constraints on this element Element IdMessageHeader.source.contact Human contact for problems DefinitionAn e-mail, phone, website or other contact point to use to resolve issues with message communications. Allows escalation of technical issues.
|
endpoint | Σ | 1..1 | url | Element IdMessageHeader.source.endpoint Endpoint applicativo sorgente DefinitionIdentifies the routing target to send acknowledgements to. Identifies where to send responses, may influence security permissions. The id may be a non-resolvable URI for systems that do not use standard network-based addresses.
|
responsible | Σ I | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | There are no (further) constraints on this element Element IdMessageHeader.responsible Final responsibility for event DefinitionThe person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party. Need to know for audit/traceback requirements and possibly for authorization. Usually only for the request but can be used in a response. Reference(Practitioner | PractitionerRole | Organization) Constraints
|
reason | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdMessageHeader.reason Cause of event DefinitionCoded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message. Need to be able to track why resources are being changed and report in the audit log/history of the resource. May affect authorization. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Reason for event occurrence. ExampleMessageReasonCodes (example)Constraints
|
response | Σ | 0..1 | BackboneElement | There are no (further) constraints on this element Element IdMessageHeader.response If this is a reply to prior message DefinitionInformation about the message that this message is a response to. Only present if this message is a response.
|
identifier | Σ | 1..1 | id | There are no (further) constraints on this element Element IdMessageHeader.response.identifier Id of original message DefinitionThe MessageHeader.id of the message to which this message is a response. Allows receiver to know what message is being responded to. RFC 4122
|
code | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element IdMessageHeader.response.code ok | transient-error | fatal-error DefinitionCode that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not. Allows the sender of the acknowledge message to know if the request was successful or if action is needed. This is a generic response to the request message. Specific data for the response will be found in MessageHeader.focus. The kind of response to a message. ResponseType (required)Constraints
|
details | Σ I | 0..1 | Reference(OperationOutcome) | There are no (further) constraints on this element Element IdMessageHeader.response.details Specific list of hints/warnings/errors DefinitionFull details of any issues found in the message. Allows the sender of the message to determine what the specific issues are. This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error.
|
focus | Σ I | 0..* | Reference(RLOperationOutcome) | Element IdMessageHeader.focus Codifica risposta validazione DefinitionReference al profilo RLOperationOutcome Every message event is about actual data, a single resource, that is identified in the definition of the event, and perhaps some or all linked resources. The data is defined where the transaction type is defined. The transaction data is always included in the bundle that is the full message. Only the root resource is specified. The resources it references should be contained in the bundle but are not also listed here. Multiple repetitions are allowed to cater for merges and other situations with multiple focal targets.
|
definition | Σ | 0..1 | canonical(MessageDefinition) | There are no (further) constraints on this element Element IdMessageHeader.definition Link to the definition for this message DefinitionPermanent link to the MessageDefinition for this message. Allows sender to define the expected contents of the message.
|
Table View
MessageHeader | .. | |
MessageHeader.event[x] | Coding | .. |
MessageHeader.event[x].code | .. | |
MessageHeader.event[x].display | .. | |
MessageHeader.destination | .. | |
MessageHeader.destination.name | .. | |
MessageHeader.destination.endpoint | .. | |
MessageHeader.source | .. | |
MessageHeader.source.name | .. | |
MessageHeader.source.endpoint | .. | |
MessageHeader.focus | Reference(RLOperationOutcome) | .. |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <url value="https://fhir.siss.regione.lombardia.it/StructureDefinition/RLMessageHeaderControlloCoerenza" /> <name value="RLMessageHeaderControlloCoerenza" /> <status value="draft" /> <description value="Profilo volto a notificare all'ente chiamato la presenza di errori di coerenza dei dati inviati." /> <keyword> <system value="https://fhir.siss.regione.lombardia.it/CodeSystem/Tag" /> <code value="PI" /> </keyword> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="MessageHeader" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/MessageHeader" /> <derivation value="constraint" /> <differential> <element id="MessageHeader.event[x]"> <path value="MessageHeader.event[x]" /> <short value="Codice identificativo della natura del messaggio" /> <type> <code value="Coding" /> </type> </element> <element id="MessageHeader.event[x].code"> <path value="MessageHeader.event[x].code" /> <short value="Codice identificativo della natura del messaggio" /> <definition value=""1" - Evento di fallimento di controlli di coerenza" /> </element> <element id="MessageHeader.event[x].display"> <path value="MessageHeader.event[x].display" /> <short value="Descrizione" /> <definition value=""1" - Evento di fallimento di controlli di coerenza" /> </element> <element id="MessageHeader.destination"> <path value="MessageHeader.destination" /> <short value="Applicativo destinatario" /> </element> <element id="MessageHeader.destination.name"> <path value="MessageHeader.destination.name" /> <short value="Ente erogatore" /> </element> <element id="MessageHeader.destination.endpoint"> <path value="MessageHeader.destination.endpoint" /> <short value="Endpoint applicativo destinatario" /> </element> <element id="MessageHeader.source"> <path value="MessageHeader.source" /> <short value="Applicativo sorgente" /> </element> <element id="MessageHeader.source.name"> <path value="MessageHeader.source.name" /> <short value="Server FHIR NPRI" /> </element> <element id="MessageHeader.source.endpoint"> <path value="MessageHeader.source.endpoint" /> <short value="Endpoint applicativo sorgente" /> </element> <element id="MessageHeader.focus"> <path value="MessageHeader.focus" /> <short value="Codifica risposta validazione" /> <definition value="Reference al profilo RLOperationOutcome" /> <type> <code value="Reference" /> <targetProfile value="https://fhir.siss.regione.lombardia.it/StructureDefinition/RLOperationOutcome" /> </type> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "url": "https://fhir.siss.regione.lombardia.it/StructureDefinition/RLMessageHeaderControlloCoerenza", "name": "RLMessageHeaderControlloCoerenza", "status": "draft", "description": "Profilo volto a notificare all'ente chiamato la presenza di errori di coerenza dei dati inviati.", "keyword": [ { "system": "https://fhir.siss.regione.lombardia.it/CodeSystem/Tag", "code": "PI" } ], "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "MessageHeader", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/MessageHeader", "derivation": "constraint", "differential": { "element": [ { "id": "MessageHeader.event[x]", "path": "MessageHeader.event[x]", "short": "Codice identificativo della natura del messaggio", "type": [ { "code": "Coding" } ] }, { "id": "MessageHeader.event[x].code", "path": "MessageHeader.event[x].code", "short": "Codice identificativo della natura del messaggio", "definition": "\"1\" - Evento di fallimento di controlli di coerenza" }, { "id": "MessageHeader.event[x].display", "path": "MessageHeader.event[x].display", "short": "Descrizione", "definition": "\"1\" - Evento di fallimento di controlli di coerenza" }, { "id": "MessageHeader.destination", "path": "MessageHeader.destination", "short": "Applicativo destinatario" }, { "id": "MessageHeader.destination.name", "path": "MessageHeader.destination.name", "short": "Ente erogatore" }, { "id": "MessageHeader.destination.endpoint", "path": "MessageHeader.destination.endpoint", "short": "Endpoint applicativo destinatario" }, { "id": "MessageHeader.source", "path": "MessageHeader.source", "short": "Applicativo sorgente" }, { "id": "MessageHeader.source.name", "path": "MessageHeader.source.name", "short": "Server FHIR NPRI" }, { "id": "MessageHeader.source.endpoint", "path": "MessageHeader.source.endpoint", "short": "Endpoint applicativo sorgente" }, { "id": "MessageHeader.focus", "path": "MessageHeader.focus", "short": "Codifica risposta validazione", "definition": "Reference al profilo RLOperationOutcome", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.siss.regione.lombardia.it/StructureDefinition/RLOperationOutcome" ] } ] } ] } }