At-Home In-Vitro Test Report
1.1.0 - STU 1.1 United States of America flag

This page is part of the At-Home In-Vitro Test Report (v1.1.0: STU 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: MessageHeader - At-Home In-Vitro Test Results

Official URL: http://hl7.org/fhir/us/home-lab-report/StructureDefinition/MessageHeader-at-home-in-vitro-test-results Version: 1.1.0
Active as of 2024-08-08 Computable Name: MessageHeaderAtHomeInVitroTestResults
Other Identifiers: OID:2.16.840.1.113883.4.642.40.32.42.9

This MessageHeader represents the At-Home In-Vitro Test Results being sent from an application server to a health authority.

See the following pages for guidance:

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 MessageHeader
... event[x] S 1..1 Coding Result of most recent lab test for condition of interest
Required Pattern: At least the following
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 96552-5
... destination S 0..* BackboneElement Message destination application(s)
.... name S 0..1 string Receiving system namespace (name of destination application). See 'Receiving System Specific Fields' (see Guidance->Getting Started for details). V2: MSH-5.1
.... endpoint S 1..1 url Receiving system OID. See 'Receiving System Specific Fields' (see Guidance->Getting Started for details). V2: MSH-5.2
.... receiver S 0..1 Reference(US Core Organization Profile) Organization.identifier.value & Organization.name: Receiving facility name; Organization.identifier.system: Receiving facility id; Organization.identifier.type: Receiving facility id type. See 'Receiving System Specific Fields' (see Guidance->Getting Started for details). V2: MSH-6.1, MSH-6.2, MSH-6.3
... sender S 0..1 Reference(US Core Organization Profile) Organization.name: Sending facility name; Organization.identifier[CLIA].value: Sending facility ID; Organization.identifier[CLIA].system (urn:oid:2.16.840.1.113883.4.7): Sending facility ID type. See 'Obtaining App Specific Identifiers' (see Guidance->Getting Started for details). V2: MSH-4.1, MSH-4.2, MSH-4.3
.... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
..... sourceSoftwareVendorInfo S 0..* (Complex) Source software information (vendor organization, binary id, install date)
URL: http://hl7.org/fhir/us/home-lab-report/StructureDefinition/Extension-at-home-in-vitro-test-source-software-info
.... name S 0..1 string Sending system namespace (name of app). If converting FHIR to V2, must be less than 20 characters. V2: MSH-3.1
.... software 0..1 string Software product name including OS (e.g. Android, iOS). V2: SFT-3
.... version S 0..1 string Software certified version or release number. V2: SFT-2
.... endpoint S 1..1 url Sending system OID. See 'Obtaining App Specific Identifiers' (see Guidance->Getting Started for details). V2: MSH-3.2
... focus S 1..1 Reference(DiagnosticReport - At-Home In-Vitro Results) The focus of this message header is a DiagnosticReport.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..* MessageHeader A resource that describes a message that is exchanged between systems
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... event[x] SΣ 1..1 Coding Result of most recent lab test for condition of interest
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.


Required Pattern: At least the following
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 96552-5
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name SΣ 0..1 string Receiving system namespace (name of destination application). See 'Receiving System Specific Fields' (see Guidance->Getting Started for details). V2: MSH-5.1
.... endpoint SΣ 1..1 url Receiving system OID. See 'Receiving System Specific Fields' (see Guidance->Getting Started for details). V2: MSH-5.2
.... receiver SΣ 0..1 Reference(US Core Organization Profile) Organization.identifier.value & Organization.name: Receiving facility name; Organization.identifier.system: Receiving facility id; Organization.identifier.type: Receiving facility id type. See 'Receiving System Specific Fields' (see Guidance->Getting Started for details). V2: MSH-6.1, MSH-6.2, MSH-6.3
... sender SΣ 0..1 Reference(US Core Organization Profile) Organization.name: Sending facility name; Organization.identifier[CLIA].value: Sending facility ID; Organization.identifier[CLIA].system (urn:oid:2.16.840.1.113883.4.7): Sending facility ID type. See 'Obtaining App Specific Identifiers' (see Guidance->Getting Started for details). V2: MSH-4.1, MSH-4.2, MSH-4.3
... source SΣ 1..1 BackboneElement Message source application
.... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
..... sourceSoftwareVendorInfo S 0..* (Complex) Source software information (vendor organization, binary id, install date)
URL: http://hl7.org/fhir/us/home-lab-report/StructureDefinition/Extension-at-home-in-vitro-test-source-software-info
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name SΣ 0..1 string Sending system namespace (name of app). If converting FHIR to V2, must be less than 20 characters. V2: MSH-3.1
.... software Σ 0..1 string Software product name including OS (e.g. Android, iOS). V2: SFT-3
.... version SΣ 0..1 string Software certified version or release number. V2: SFT-2
.... endpoint SΣ 1..1 url Sending system OID. See 'Obtaining App Specific Identifiers' (see Guidance->Getting Started for details). V2: MSH-3.2
... focus SΣ 1..1 Reference(DiagnosticReport - At-Home In-Vitro Results) The focus of this message header is a DiagnosticReport.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MessageHeader.event[x]examplePattern: LOINC Code 96552-5
http://hl7.org/fhir/ValueSet/message-events
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..* MessageHeader A resource that describes a message that is exchanged between systems
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... event[x] SΣ 1..1 Coding Result of most recent lab test for condition of interest
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.


Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
.... version 0..1 string Version of the system - if relevant
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 96552-5
.... display 0..1 string Representation defined by the system
.... userSelected 0..1 boolean If this coding was chosen directly by the user
... destination SΣ 0..* BackboneElement Message destination application(s)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name SΣ 0..1 string Receiving system namespace (name of destination application). See 'Receiving System Specific Fields' (see Guidance->Getting Started for details). V2: MSH-5.1
.... target Σ 0..1 Reference(Device) Particular delivery destination within the destination
.... endpoint SΣ 1..1 url Receiving system OID. See 'Receiving System Specific Fields' (see Guidance->Getting Started for details). V2: MSH-5.2
.... receiver SΣ 0..1 Reference(US Core Organization Profile) Organization.identifier.value & Organization.name: Receiving facility name; Organization.identifier.system: Receiving facility id; Organization.identifier.type: Receiving facility id type. See 'Receiving System Specific Fields' (see Guidance->Getting Started for details). V2: MSH-6.1, MSH-6.2, MSH-6.3
... sender SΣ 0..1 Reference(US Core Organization Profile) Organization.name: Sending facility name; Organization.identifier[CLIA].value: Sending facility ID; Organization.identifier[CLIA].system (urn:oid:2.16.840.1.113883.4.7): Sending facility ID type. See 'Obtaining App Specific Identifiers' (see Guidance->Getting Started for details). V2: MSH-4.1, MSH-4.2, MSH-4.3
... enterer Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the data entry
... author Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the decision
... source SΣ 1..1 BackboneElement Message source application
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
..... sourceSoftwareVendorInfo S 0..* (Complex) Source software information (vendor organization, binary id, install date)
URL: http://hl7.org/fhir/us/home-lab-report/StructureDefinition/Extension-at-home-in-vitro-test-source-software-info
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name SΣ 0..1 string Sending system namespace (name of app). If converting FHIR to V2, must be less than 20 characters. V2: MSH-3.1
.... software Σ 0..1 string Software product name including OS (e.g. Android, iOS). V2: SFT-3
.... version SΣ 0..1 string Software certified version or release number. V2: SFT-2
.... contact Σ 0..1 ContactPoint Human contact for problems
.... endpoint SΣ 1..1 url Sending system OID. See 'Obtaining App Specific Identifiers' (see Guidance->Getting Started for details). V2: MSH-3.2
... responsible Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Final responsibility for event
... reason Σ 0..1 CodeableConcept Cause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.

... response Σ 0..1 BackboneElement If this is a reply to prior message
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier Σ 1..1 id Id of original message
.... code Σ 1..1 code ok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details Σ 0..1 Reference(OperationOutcome) Specific list of hints/warnings/errors
... focus SΣ 1..1 Reference(DiagnosticReport - At-Home In-Vitro Results) The focus of this message header is a DiagnosticReport.
... definition Σ 0..1 canonical(MessageDefinition) Link to the definition for this message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MessageHeader.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MessageHeader.event[x]examplePattern: LOINC Code 96552-5
http://hl7.org/fhir/ValueSet/message-events
from the FHIR Standard
MessageHeader.reasonexampleExampleMessageReasonCodes
http://hl7.org/fhir/ValueSet/message-reason-encounter
from the FHIR Standard
MessageHeader.response.coderequiredResponseType
http://hl7.org/fhir/ValueSet/response-code|4.0.1
from the FHIR Standard

Differential View

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader MessageHeader
... event[x] S 1..1 Coding Result of most recent lab test for condition of interest
Required Pattern: At least the following
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 96552-5
... destination S 0..* BackboneElement Message destination application(s)
.... name S 0..1 string Receiving system namespace (name of destination application). See 'Receiving System Specific Fields' (see Guidance->Getting Started for details). V2: MSH-5.1
.... endpoint S 1..1 url Receiving system OID. See 'Receiving System Specific Fields' (see Guidance->Getting Started for details). V2: MSH-5.2
.... receiver S 0..1 Reference(US Core Organization Profile) Organization.identifier.value & Organization.name: Receiving facility name; Organization.identifier.system: Receiving facility id; Organization.identifier.type: Receiving facility id type. See 'Receiving System Specific Fields' (see Guidance->Getting Started for details). V2: MSH-6.1, MSH-6.2, MSH-6.3
... sender S 0..1 Reference(US Core Organization Profile) Organization.name: Sending facility name; Organization.identifier[CLIA].value: Sending facility ID; Organization.identifier[CLIA].system (urn:oid:2.16.840.1.113883.4.7): Sending facility ID type. See 'Obtaining App Specific Identifiers' (see Guidance->Getting Started for details). V2: MSH-4.1, MSH-4.2, MSH-4.3
.... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
..... sourceSoftwareVendorInfo S 0..* (Complex) Source software information (vendor organization, binary id, install date)
URL: http://hl7.org/fhir/us/home-lab-report/StructureDefinition/Extension-at-home-in-vitro-test-source-software-info
.... name S 0..1 string Sending system namespace (name of app). If converting FHIR to V2, must be less than 20 characters. V2: MSH-3.1
.... software 0..1 string Software product name including OS (e.g. Android, iOS). V2: SFT-3
.... version S 0..1 string Software certified version or release number. V2: SFT-2
.... endpoint S 1..1 url Sending system OID. See 'Obtaining App Specific Identifiers' (see Guidance->Getting Started for details). V2: MSH-3.2
... focus S 1..1 Reference(DiagnosticReport - At-Home In-Vitro Results) The focus of this message header is a DiagnosticReport.

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..* MessageHeader A resource that describes a message that is exchanged between systems
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... event[x] SΣ 1..1 Coding Result of most recent lab test for condition of interest
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.


Required Pattern: At least the following
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 96552-5
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name SΣ 0..1 string Receiving system namespace (name of destination application). See 'Receiving System Specific Fields' (see Guidance->Getting Started for details). V2: MSH-5.1
.... endpoint SΣ 1..1 url Receiving system OID. See 'Receiving System Specific Fields' (see Guidance->Getting Started for details). V2: MSH-5.2
.... receiver SΣ 0..1 Reference(US Core Organization Profile) Organization.identifier.value & Organization.name: Receiving facility name; Organization.identifier.system: Receiving facility id; Organization.identifier.type: Receiving facility id type. See 'Receiving System Specific Fields' (see Guidance->Getting Started for details). V2: MSH-6.1, MSH-6.2, MSH-6.3
... sender SΣ 0..1 Reference(US Core Organization Profile) Organization.name: Sending facility name; Organization.identifier[CLIA].value: Sending facility ID; Organization.identifier[CLIA].system (urn:oid:2.16.840.1.113883.4.7): Sending facility ID type. See 'Obtaining App Specific Identifiers' (see Guidance->Getting Started for details). V2: MSH-4.1, MSH-4.2, MSH-4.3
... source SΣ 1..1 BackboneElement Message source application
.... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
..... sourceSoftwareVendorInfo S 0..* (Complex) Source software information (vendor organization, binary id, install date)
URL: http://hl7.org/fhir/us/home-lab-report/StructureDefinition/Extension-at-home-in-vitro-test-source-software-info
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name SΣ 0..1 string Sending system namespace (name of app). If converting FHIR to V2, must be less than 20 characters. V2: MSH-3.1
.... software Σ 0..1 string Software product name including OS (e.g. Android, iOS). V2: SFT-3
.... version SΣ 0..1 string Software certified version or release number. V2: SFT-2
.... endpoint SΣ 1..1 url Sending system OID. See 'Obtaining App Specific Identifiers' (see Guidance->Getting Started for details). V2: MSH-3.2
... focus SΣ 1..1 Reference(DiagnosticReport - At-Home In-Vitro Results) The focus of this message header is a DiagnosticReport.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MessageHeader.event[x]examplePattern: LOINC Code 96552-5
http://hl7.org/fhir/ValueSet/message-events
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..* MessageHeader A resource that describes a message that is exchanged between systems
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... event[x] SΣ 1..1 Coding Result of most recent lab test for condition of interest
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.


Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
.... version 0..1 string Version of the system - if relevant
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 96552-5
.... display 0..1 string Representation defined by the system
.... userSelected 0..1 boolean If this coding was chosen directly by the user
... destination SΣ 0..* BackboneElement Message destination application(s)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name SΣ 0..1 string Receiving system namespace (name of destination application). See 'Receiving System Specific Fields' (see Guidance->Getting Started for details). V2: MSH-5.1
.... target Σ 0..1 Reference(Device) Particular delivery destination within the destination
.... endpoint SΣ 1..1 url Receiving system OID. See 'Receiving System Specific Fields' (see Guidance->Getting Started for details). V2: MSH-5.2
.... receiver SΣ 0..1 Reference(US Core Organization Profile) Organization.identifier.value & Organization.name: Receiving facility name; Organization.identifier.system: Receiving facility id; Organization.identifier.type: Receiving facility id type. See 'Receiving System Specific Fields' (see Guidance->Getting Started for details). V2: MSH-6.1, MSH-6.2, MSH-6.3
... sender SΣ 0..1 Reference(US Core Organization Profile) Organization.name: Sending facility name; Organization.identifier[CLIA].value: Sending facility ID; Organization.identifier[CLIA].system (urn:oid:2.16.840.1.113883.4.7): Sending facility ID type. See 'Obtaining App Specific Identifiers' (see Guidance->Getting Started for details). V2: MSH-4.1, MSH-4.2, MSH-4.3
... enterer Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the data entry
... author Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the decision
... source SΣ 1..1 BackboneElement Message source application
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
..... sourceSoftwareVendorInfo S 0..* (Complex) Source software information (vendor organization, binary id, install date)
URL: http://hl7.org/fhir/us/home-lab-report/StructureDefinition/Extension-at-home-in-vitro-test-source-software-info
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name SΣ 0..1 string Sending system namespace (name of app). If converting FHIR to V2, must be less than 20 characters. V2: MSH-3.1
.... software Σ 0..1 string Software product name including OS (e.g. Android, iOS). V2: SFT-3
.... version SΣ 0..1 string Software certified version or release number. V2: SFT-2
.... contact Σ 0..1 ContactPoint Human contact for problems
.... endpoint SΣ 1..1 url Sending system OID. See 'Obtaining App Specific Identifiers' (see Guidance->Getting Started for details). V2: MSH-3.2
... responsible Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Final responsibility for event
... reason Σ 0..1 CodeableConcept Cause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.

... response Σ 0..1 BackboneElement If this is a reply to prior message
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier Σ 1..1 id Id of original message
.... code Σ 1..1 code ok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details Σ 0..1 Reference(OperationOutcome) Specific list of hints/warnings/errors
... focus SΣ 1..1 Reference(DiagnosticReport - At-Home In-Vitro Results) The focus of this message header is a DiagnosticReport.
... definition Σ 0..1 canonical(MessageDefinition) Link to the definition for this message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MessageHeader.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MessageHeader.event[x]examplePattern: LOINC Code 96552-5
http://hl7.org/fhir/ValueSet/message-events
from the FHIR Standard
MessageHeader.reasonexampleExampleMessageReasonCodes
http://hl7.org/fhir/ValueSet/message-reason-encounter
from the FHIR Standard
MessageHeader.response.coderequiredResponseType
http://hl7.org/fhir/ValueSet/response-code|4.0.1
from the FHIR Standard

 

Other representations of profile: CSV, Excel, Schematron