Making Electronic Data More available for Research and Public Health (MedMorph)
1.0.0 - STU 1 United States of America flag

Making Electronic Data More available for Research and Public Health (MedMorph), published by HL7 International - Public Health Work Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/fhir-medmorph/ and changes regularly. See the Directory of published versions

Resource Profile: US Public Health MessageHeader

Official URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-messageheader Version: 1.0.0
Draft as of 2019-09-01 Computable Name: USPublicHealthMessageHeader

This is the MessageHeader Resource profile for the IG.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderUS Public Health MessageHeader
... Slices for extension S1..*ExtensionExtension
Slice: Unordered, Open by value:url
... dataEncrypted S0..1booleanUS Public Health Data Encrypted Extension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-data-encrypted-extension
... reportInitiationType S1..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-report-initiation-type
Binding: US Public Health Report Initiation Type (extensible): Initiation Types

... destination S1..*BackboneElementMessage destination application(s)
.... endpoint S1..1urlActual destination address or id
... sender S1..1Reference(US Public Health Organization)Real world sender of the message
... source S1..1BackboneElementMessage source application
.... endpoint S1..1urlActual message source address or id
... reason S1..1CodeableConceptThe named event that gave rise to the message
Binding: US Public Health TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents

... response S0..1BackboneElementIf this is a reply to prior message
.... identifier S1..1idId of original message
.... code S1..1codeok | transient-error | fatal-error
.... details S0..1Reference(OperationOutcome)Specific list of hints/warnings/errors
... definition S0..1canonical(US Public Health MessageDefinition)Link to the definition for this message

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
MessageHeader.event[x]extensibleUSPublicHealthMessageTypes (a valid code from US Public Health Message Type Codes)
MessageHeader.reasonextensibleUSPublicHealthTriggerDefinitionNamedEvent (a valid code from US Public Health TriggerDefinition Named Events)
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderUS Public Health MessageHeader
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension S1..*ExtensionExtension
Slice: Unordered, Open by value:url
... dataEncrypted S0..1booleanUS Public Health Data Encrypted Extension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-data-encrypted-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... event[x] SΣ1..1CodingTypes of messages being sent between systems
Binding: US Public Health Message Types (extensible): US Public Health Message Types ValueSet

... destination SΣ1..*BackboneElementMessage destination application(s)
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... endpoint SΣ1..1urlActual destination address or id
... sender SΣ1..1Reference(US Public Health Organization)Real world sender of the message
... source SΣ1..1BackboneElementMessage source application
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... endpoint SΣ1..1urlActual message source address or id
... reason SΣ1..1CodeableConceptThe named event that gave rise to the message
Binding: US Public Health TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents

... response SΣ0..1BackboneElementIf this is a reply to prior message
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier SΣ1..1idId of original message
.... code SΣ1..1codeok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details SΣ0..1Reference(OperationOutcome)Specific list of hints/warnings/errors
... definition SΣ0..1canonical(US Public Health MessageDefinition)Link to the definition for this message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
MessageHeader.event[x]extensibleUSPublicHealthMessageTypes (a valid code from US Public Health Message Type Codes)
MessageHeader.reasonextensibleUSPublicHealthTriggerDefinitionNamedEvent (a valid code from US Public Health TriggerDefinition Named Events)
MessageHeader.response.coderequiredResponseType

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMessageHeaderIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMessageHeaderIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMessageHeaderA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderUS Public Health MessageHeader
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension S1..*ExtensionExtension
Slice: Unordered, Open by value:url
... dataEncrypted S0..1booleanUS Public Health Data Encrypted Extension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-data-encrypted-extension
... reportInitiationType S1..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-report-initiation-type
Binding: US Public Health Report Initiation Type (extensible): Initiation Types


... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... event[x] SΣ1..1CodingTypes of messages being sent between systems
Binding: US Public Health Message Types (extensible): US Public Health Message Types ValueSet

... destination SΣ1..*BackboneElementMessage destination application(s)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ0..1stringName of system
.... target Σ0..1Reference(Device)Particular delivery destination within the destination
.... endpoint SΣ1..1urlActual destination address or id
.... receiver Σ0..1Reference(Practitioner | PractitionerRole | Organization)Intended "real-world" recipient for the data
... sender SΣ1..1Reference(US Public Health Organization)Real world sender of the message
... enterer Σ0..1Reference(Practitioner | PractitionerRole)The source of the data entry
... author Σ0..1Reference(Practitioner | PractitionerRole)The source of the decision
... source SΣ1..1BackboneElementMessage source application
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ0..1stringName of system
.... software Σ0..1stringName of software running the system
.... version Σ0..1stringVersion of software running
.... contact Σ0..1ContactPointHuman contact for problems
.... endpoint SΣ1..1urlActual message source address or id
... responsible Σ0..1Reference(Practitioner | PractitionerRole | Organization)Final responsibility for event
... reason SΣ1..1CodeableConceptThe named event that gave rise to the message
Binding: US Public Health TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents

... response SΣ0..1BackboneElementIf this is a reply to prior message
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier SΣ1..1idId of original message
.... code SΣ1..1codeok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details SΣ0..1Reference(OperationOutcome)Specific list of hints/warnings/errors
... focus Σ0..*Reference(Resource)The actual content of the message
... definition SΣ0..1canonical(US Public Health MessageDefinition)Link to the definition for this message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
MessageHeader.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
MessageHeader.event[x]extensibleUSPublicHealthMessageTypes (a valid code from US Public Health Message Type Codes)
MessageHeader.reasonextensibleUSPublicHealthTriggerDefinitionNamedEvent (a valid code from US Public Health TriggerDefinition Named Events)
MessageHeader.response.coderequiredResponseType

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderUS Public Health MessageHeader
... Slices for extension S1..*ExtensionExtension
Slice: Unordered, Open by value:url
... dataEncrypted S0..1booleanUS Public Health Data Encrypted Extension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-data-encrypted-extension
... reportInitiationType S1..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-report-initiation-type
Binding: US Public Health Report Initiation Type (extensible): Initiation Types

... destination S1..*BackboneElementMessage destination application(s)
.... endpoint S1..1urlActual destination address or id
... sender S1..1Reference(US Public Health Organization)Real world sender of the message
... source S1..1BackboneElementMessage source application
.... endpoint S1..1urlActual message source address or id
... reason S1..1CodeableConceptThe named event that gave rise to the message
Binding: US Public Health TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents

... response S0..1BackboneElementIf this is a reply to prior message
.... identifier S1..1idId of original message
.... code S1..1codeok | transient-error | fatal-error
.... details S0..1Reference(OperationOutcome)Specific list of hints/warnings/errors
... definition S0..1canonical(US Public Health MessageDefinition)Link to the definition for this message

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
MessageHeader.event[x]extensibleUSPublicHealthMessageTypes (a valid code from US Public Health Message Type Codes)
MessageHeader.reasonextensibleUSPublicHealthTriggerDefinitionNamedEvent (a valid code from US Public Health TriggerDefinition Named Events)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderUS Public Health MessageHeader
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension S1..*ExtensionExtension
Slice: Unordered, Open by value:url
... dataEncrypted S0..1booleanUS Public Health Data Encrypted Extension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-data-encrypted-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... event[x] SΣ1..1CodingTypes of messages being sent between systems
Binding: US Public Health Message Types (extensible): US Public Health Message Types ValueSet

... destination SΣ1..*BackboneElementMessage destination application(s)
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... endpoint SΣ1..1urlActual destination address or id
... sender SΣ1..1Reference(US Public Health Organization)Real world sender of the message
... source SΣ1..1BackboneElementMessage source application
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... endpoint SΣ1..1urlActual message source address or id
... reason SΣ1..1CodeableConceptThe named event that gave rise to the message
Binding: US Public Health TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents

... response SΣ0..1BackboneElementIf this is a reply to prior message
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier SΣ1..1idId of original message
.... code SΣ1..1codeok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details SΣ0..1Reference(OperationOutcome)Specific list of hints/warnings/errors
... definition SΣ0..1canonical(US Public Health MessageDefinition)Link to the definition for this message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
MessageHeader.event[x]extensibleUSPublicHealthMessageTypes (a valid code from US Public Health Message Type Codes)
MessageHeader.reasonextensibleUSPublicHealthTriggerDefinitionNamedEvent (a valid code from US Public Health TriggerDefinition Named Events)
MessageHeader.response.coderequiredResponseType

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMessageHeaderIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMessageHeaderIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMessageHeaderA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderUS Public Health MessageHeader
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension S1..*ExtensionExtension
Slice: Unordered, Open by value:url
... dataEncrypted S0..1booleanUS Public Health Data Encrypted Extension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-data-encrypted-extension
... reportInitiationType S1..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-report-initiation-type
Binding: US Public Health Report Initiation Type (extensible): Initiation Types


... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... event[x] SΣ1..1CodingTypes of messages being sent between systems
Binding: US Public Health Message Types (extensible): US Public Health Message Types ValueSet

... destination SΣ1..*BackboneElementMessage destination application(s)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ0..1stringName of system
.... target Σ0..1Reference(Device)Particular delivery destination within the destination
.... endpoint SΣ1..1urlActual destination address or id
.... receiver Σ0..1Reference(Practitioner | PractitionerRole | Organization)Intended "real-world" recipient for the data
... sender SΣ1..1Reference(US Public Health Organization)Real world sender of the message
... enterer Σ0..1Reference(Practitioner | PractitionerRole)The source of the data entry
... author Σ0..1Reference(Practitioner | PractitionerRole)The source of the decision
... source SΣ1..1BackboneElementMessage source application
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ0..1stringName of system
.... software Σ0..1stringName of software running the system
.... version Σ0..1stringVersion of software running
.... contact Σ0..1ContactPointHuman contact for problems
.... endpoint SΣ1..1urlActual message source address or id
... responsible Σ0..1Reference(Practitioner | PractitionerRole | Organization)Final responsibility for event
... reason SΣ1..1CodeableConceptThe named event that gave rise to the message
Binding: US Public Health TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents

... response SΣ0..1BackboneElementIf this is a reply to prior message
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier SΣ1..1idId of original message
.... code SΣ1..1codeok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details SΣ0..1Reference(OperationOutcome)Specific list of hints/warnings/errors
... focus Σ0..*Reference(Resource)The actual content of the message
... definition SΣ0..1canonical(US Public Health MessageDefinition)Link to the definition for this message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
MessageHeader.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
MessageHeader.event[x]extensibleUSPublicHealthMessageTypes (a valid code from US Public Health Message Type Codes)
MessageHeader.reasonextensibleUSPublicHealthTriggerDefinitionNamedEvent (a valid code from US Public Health TriggerDefinition Named Events)
MessageHeader.response.coderequiredResponseType

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron