HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm CI Build

This page is part of the electronic Case Reporting (eCR) (v1.0.0: STU 1) based on FHIR R4. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions

SD.4 StructureDefinition-ecr-messageheader

This MessageHeader profile represents metadata to support the eCR messaging paradigm. It requires data elements destination, sender, source, and focus. The focus of an eCR MessageHeader profile is the eCR Task profile.

SD.4.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/us/ecr/StructureDefinition/ecr-messageheader

Published on Wed Jan 29 20:30:08 UTC 2020 as a active by HL7 Public Health Work Group.

This profile builds on MessageHeader


Summary

Mandatory: 3 elements
Must-Support: 6 elements

Structures

This structure refers to these other structures:

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader I0..*MessageHeaderA resource that describes a message that is exchanged between systems
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... event[x] SΣI1..1CodingCode for the event this message represents or link to event definition
Binding: eCR MessageHeader Event Value Set (extensible)
... destination SΣI1..1BackboneElementMessage destination application(s)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name ΣI0..1stringName of system
.... target ΣI0..1Reference(Device)Particular delivery destination within the destination
.... endpoint ΣI1..1urlActual destination address or id
.... receiver ΣI0..1Reference(Practitioner | PractitionerRole | Organization)Intended "real-world" recipient for the data
... sender SΣI1..1Reference(Practitioner | PractitionerRole | Organization)Real world sender of the message
... enterer ΣI0..1Reference(Practitioner | PractitionerRole)The source of the data entry
... author ΣI0..1Reference(Practitioner | PractitionerRole)The source of the decision
... source ΣI1..1BackboneElementMessage source application
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name SΣI0..1stringName of system
.... software ΣI0..1stringName of software running the system
.... version ΣI0..1stringVersion of software running
.... contact SΣI0..1ContactPointHuman contact for problems
.... endpoint ΣI1..1urlActual message source address or id
... responsible ΣI0..1Reference(Practitioner | PractitionerRole | Organization)Final responsibility for event
... reason ΣI0..1CodeableConceptCause of event
Binding: ExampleMessageReasonCodes (example)
... response ΣI0..1BackboneElementIf this is a reply to prior message
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier ΣI1..1idId of original message
.... code ΣI1..1codeok | transient-error | fatal-error
Binding: ResponseType (required)
.... details ΣI0..1Reference(OperationOutcome)Specific list of hints/warnings/errors
... focus SΣI1..1Reference(eCR Task)The actual content of the message
... definition ΣI0..1canonical(MessageDefinition)Link to the definition for this message

doco Documentation for this format

Summary

Mandatory: 3 elements
Must-Support: 6 elements

Structures

This structure refers to these other structures:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader I0..*MessageHeaderA resource that describes a message that is exchanged between systems
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... event[x] SΣI1..1CodingCode for the event this message represents or link to event definition
Binding: eCR MessageHeader Event Value Set (extensible)
... destination SΣI1..1BackboneElementMessage destination application(s)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name ΣI0..1stringName of system
.... target ΣI0..1Reference(Device)Particular delivery destination within the destination
.... endpoint ΣI1..1urlActual destination address or id
.... receiver ΣI0..1Reference(Practitioner | PractitionerRole | Organization)Intended "real-world" recipient for the data
... sender SΣI1..1Reference(Practitioner | PractitionerRole | Organization)Real world sender of the message
... enterer ΣI0..1Reference(Practitioner | PractitionerRole)The source of the data entry
... author ΣI0..1Reference(Practitioner | PractitionerRole)The source of the decision
... source ΣI1..1BackboneElementMessage source application
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name SΣI0..1stringName of system
.... software ΣI0..1stringName of software running the system
.... version ΣI0..1stringVersion of software running
.... contact SΣI0..1ContactPointHuman contact for problems
.... endpoint ΣI1..1urlActual message source address or id
... responsible ΣI0..1Reference(Practitioner | PractitionerRole | Organization)Final responsibility for event
... reason ΣI0..1CodeableConceptCause of event
Binding: ExampleMessageReasonCodes (example)
... response ΣI0..1BackboneElementIf this is a reply to prior message
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier ΣI1..1idId of original message
.... code ΣI1..1codeok | transient-error | fatal-error
Binding: ResponseType (required)
.... details ΣI0..1Reference(OperationOutcome)Specific list of hints/warnings/errors
... focus SΣI1..1Reference(eCR Task)The actual content of the message
... definition ΣI0..1canonical(MessageDefinition)Link to the definition for this message

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron