HL7 FHIR Implementation Guide: Profiles for ICSR Transfusion and Vaccination Adverse Event Detection and Reporting
0.1.0 - STU 1 Ballot

This page is part of the Profiles for ICSR Transfusion and Vaccination Adverse Event Detection and Reporting (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: FAERS MessageHeader

Defining URL:http://hl7.org/fhir/us/icsr-ae-reporting/StructureDefinition/ibm-fda-icsr-faers-messageheader
Version:0.1.0
Name:FAERSMessageHeader
Title:FAERS MessageHeader
Status:Active as of 2021-08-05T14:34:06+00:00
Definition:

The fields needed to create a MessageHeader for a FAERS ICSR Report.

Publisher:Biomedical Research & Regulation WG
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://hl7.org/fhir/us/icsr-ae-reporting/StructureDefinition/ibm-fda-icsr-faers-messageheader

Formal Views of Profile Content

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

This structure is derived from USPublicHealthMessageHeader

This structure is derived from USPublicHealthMessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*USPublicHealthMessageHeaderUS Public Health MessageHeader
... destination
.... receiver S1..1Reference(MessageHeader Organization)Intended "real-world" recipient for the data
... sender 1..1Reference(MessageHeader Organization)Real world sender of the message
... focus S1..1Reference(ICSR Composition)The actual content of the message

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*USPublicHealthMessageHeaderUS Public Health MessageHeader
... id Σ0..1stringLogical 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 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-dataEncrypted S0..1booleanIndicates whether the data in the content bundle is encrypted or not
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-dataEncrypted
... ext-messageProcessingCategory S1..1codeIndicates how messages should be processed
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-messageProcessingCategory
Binding: MessageSignificanceCategory (required): The message processing requirements identified by the message


... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... event[x] SΣ1..1CodingCode for the event this message represents or link to event definition
Binding: US Public Health Message Types (extensible): Types of messages being sent between systems

... 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 SΣ1..1Reference(MessageHeader Organization)Intended "real-world" recipient for the data
... sender SΣ1..1Reference(MessageHeader 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..1CodeableConceptCause of event
Binding: US Public Health TriggerDefinition NamedEvent (extensible): The named event that gave rise to the message

... 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 SΣ1..1Reference(ICSR Composition)The actual content of the message
... definition Σ0..1canonical(MessageDefinition)Link to the definition for this message

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*USPublicHealthMessageHeaderUS Public Health MessageHeader
... ext-dataEncrypted 0..1booleanIndicates whether the data in the content bundle is encrypted or not
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-dataEncrypted
... ext-messageProcessingCategory 1..1codeIndicates how messages should be processed
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-messageProcessingCategory
Binding: MessageSignificanceCategory (required): The message processing requirements identified by the message


... event[x] Σ1..1CodingCode for the event this message represents or link to event definition
Binding: US Public Health Message Types (extensible): Types of messages being sent between systems

.... endpoint Σ1..1urlActual destination address or id
.... receiver Σ1..1Reference(MessageHeader Organization)Intended "real-world" recipient for the data
... sender Σ1..1Reference(MessageHeader Organization)Real world sender of the message
... source Σ1..1BackboneElementMessage source application
.... endpoint Σ1..1urlActual message source address or id
... reason Σ1..1CodeableConceptCause of event
Binding: US Public Health TriggerDefinition NamedEvent (extensible): The named event that gave rise to the message

... response Σ0..1BackboneElementIf this is a reply to prior message
.... identifier Σ1..1idId of original message
.... code Σ1..1codeok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details Σ0..1Reference(OperationOutcome)Specific list of hints/warnings/errors
... focus Σ1..1Reference(ICSR Composition)The actual content of the message

doco Documentation for this format

This structure is derived from USPublicHealthMessageHeader

Differential View

This structure is derived from USPublicHealthMessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*USPublicHealthMessageHeaderUS Public Health MessageHeader
... destination
.... receiver S1..1Reference(MessageHeader Organization)Intended "real-world" recipient for the data
... sender 1..1Reference(MessageHeader Organization)Real world sender of the message
... focus S1..1Reference(ICSR Composition)The actual content of the message

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*USPublicHealthMessageHeaderUS Public Health MessageHeader
... id Σ0..1stringLogical 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 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-dataEncrypted S0..1booleanIndicates whether the data in the content bundle is encrypted or not
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-dataEncrypted
... ext-messageProcessingCategory S1..1codeIndicates how messages should be processed
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-messageProcessingCategory
Binding: MessageSignificanceCategory (required): The message processing requirements identified by the message


... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... event[x] SΣ1..1CodingCode for the event this message represents or link to event definition
Binding: US Public Health Message Types (extensible): Types of messages being sent between systems

... 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 SΣ1..1Reference(MessageHeader Organization)Intended "real-world" recipient for the data
... sender SΣ1..1Reference(MessageHeader 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..1CodeableConceptCause of event
Binding: US Public Health TriggerDefinition NamedEvent (extensible): The named event that gave rise to the message

... 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 SΣ1..1Reference(ICSR Composition)The actual content of the message
... definition Σ0..1canonical(MessageDefinition)Link to the definition for this message

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
MessageHeader.languagepreferredCommonLanguages
Max Binding: AllLanguages
MessageHeader.event[x]extensibleUSPublicHealthMessageTypes
MessageHeader.reasonextensibleUSPublicHealthTriggerDefinitionNamedEvent
MessageHeader.response.coderequiredResponseType