At-Home In-Vitro Test Report
1.0.0 - STU 1
At-Home In-Vitro Test Report
1.0.0 - STU 1
This page is part of the At-Home In-Vitro Test Report (v1.0.0: STU 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org/fhir/us/home-lab-report/StructureDefinition/MessageHeader-at-home-in-vitro-test-results | Version: 1.0.0 | |||
| Active as of 2023-03-25 | Computable Name: MessageHeaderAtHomeInVitroTestResults | |||
This MessageHeader represents the At-Home In-Vitro Test Results being sent from an application server to a health authority.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MessageHeader
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MessageHeader | 0..* | MessageHeader | Represents the At-Home In-Vitro Test Results being sent from an application server to a health authority. | |
  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) |
| id | S | 0..1 | string | Receiving system OID |
| name | S | 0..1 | string | Receiving system namespace (name of destination application) |
| endpoint | S | 1..1 | url | Actual destination address or id |
 receiver | S | 0..1 | Reference(US Core Organization Profile) | Intended "real-world" recipient for the data |
| sender | S | 0..1 | Reference(US Core Organization Profile) | Real world sender of the message |
| source | S | 1..1 | BackboneElement | Message source application |
| id | S | 0..1 | string | Sending system OID |
 Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
 sourceSoftwareVendorInfo | S | 0..1 | (Complex) | Source software information (vendor organization, binary id, intstall 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) |
| software | 0..1 | string | Software product name including OS (e.g. Android, iOS) | |
| version | S | 0..1 | string | Software certified version or release number |
| focus | S | 1..1 | Reference(DiagnosticReport - At-Home In-Vitro Results) | The focus of this message header is a DiagnosticReport. |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | Represents the At-Home In-Vitro Test Results being sent from an application server to a health authority. | |
 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 | |
| destination | SΣ | 0..* | BackboneElement | Message destination application(s) |
| id | S | 0..1 | string | Receiving system OID |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name | SΣ | 0..1 | string | Receiving system namespace (name of destination application) |
| endpoint | SΣ | 1..1 | url | Actual destination address or id |
| receiver | SΣ | 0..1 | Reference(US Core Organization Profile) | Intended "real-world" recipient for the data |
| sender | SΣ | 0..1 | Reference(US Core Organization Profile) | Real world sender of the message |
| source | SΣ | 1..1 | BackboneElement | Message source application |
| id | S | 0..1 | string | Sending system OID |
| Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| sourceSoftwareVendorInfo | S | 0..1 | (Complex) | Source software information (vendor organization, binary id, intstall 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) |
| software | Σ | 0..1 | string | Software product name including OS (e.g. Android, iOS) |
| version | SΣ | 0..1 | string | Software certified version or release number |
| endpoint | Σ | 1..1 | url | Actual message source address or id |
| focus | SΣ | 1..1 | Reference(DiagnosticReport - At-Home In-Vitro Results) | The focus of this message header is a DiagnosticReport. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| MessageHeader.event[x] | example | Pattern: LOINC code 96552-5 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MessageHeader | If 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-4 | error | MessageHeader | If 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-5 | error | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MessageHeader | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | Represents the At-Home In-Vitro Test Results being sent from an application server to a health authority. | |||||
| 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 | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | S | 0..1 | string | Receiving system OID | ||||
| 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) | ||||
| target | Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
| endpoint | SΣ | 1..1 | url | Actual destination address or id | ||||
| receiver | SΣ | 0..1 | Reference(US Core Organization Profile) | Intended "real-world" recipient for the data | ||||
| sender | SΣ | 0..1 | Reference(US Core Organization Profile) | Real world sender of the message | ||||
| 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 | S | 0..1 | string | Sending system OID | ||||
| Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
| sourceSoftwareVendorInfo | S | 0..1 | (Complex) | Source software information (vendor organization, binary id, intstall 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) | ||||
| software | Σ | 0..1 | string | Software product name including OS (e.g. Android, iOS) | ||||
| version | SΣ | 0..1 | string | Software certified version or release number | ||||
| contact | Σ | 0..1 | ContactPoint | Human contact for problems | ||||
| endpoint | Σ | 1..1 | url | Actual message source address or id | ||||
| 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 | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| MessageHeader.language | preferred | CommonLanguages
| ||||
| MessageHeader.event[x] | example | Pattern: LOINC code 96552-5 | ||||
| MessageHeader.reason | example | ExampleMessageReasonCodes | ||||
| MessageHeader.response.code | required | ResponseType |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from MessageHeader
Summary
Mandatory: 1 element
Must-Support: 14 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from MessageHeader
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | Represents the At-Home In-Vitro Test Results being sent from an application server to a health authority. | |
| 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) |
| id | S | 0..1 | string | Receiving system OID |
| name | S | 0..1 | string | Receiving system namespace (name of destination application) |
| endpoint | S | 1..1 | url | Actual destination address or id |
| receiver | S | 0..1 | Reference(US Core Organization Profile) | Intended "real-world" recipient for the data |
| sender | S | 0..1 | Reference(US Core Organization Profile) | Real world sender of the message |
| source | S | 1..1 | BackboneElement | Message source application |
| id | S | 0..1 | string | Sending system OID |
| Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| sourceSoftwareVendorInfo | S | 0..1 | (Complex) | Source software information (vendor organization, binary id, intstall 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) |
| software | 0..1 | string | Software product name including OS (e.g. Android, iOS) | |
| version | S | 0..1 | string | Software certified version or release number |
| focus | S | 1..1 | Reference(DiagnosticReport - At-Home In-Vitro Results) | The focus of this message header is a DiagnosticReport. |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | Represents the At-Home In-Vitro Test Results being sent from an application server to a health authority. | |
| 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 | |
| destination | SΣ | 0..* | BackboneElement | Message destination application(s) |
| id | S | 0..1 | string | Receiving system OID |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name | SΣ | 0..1 | string | Receiving system namespace (name of destination application) |
| endpoint | SΣ | 1..1 | url | Actual destination address or id |
| receiver | SΣ | 0..1 | Reference(US Core Organization Profile) | Intended "real-world" recipient for the data |
| sender | SΣ | 0..1 | Reference(US Core Organization Profile) | Real world sender of the message |
| source | SΣ | 1..1 | BackboneElement | Message source application |
| id | S | 0..1 | string | Sending system OID |
| Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| sourceSoftwareVendorInfo | S | 0..1 | (Complex) | Source software information (vendor organization, binary id, intstall 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) |
| software | Σ | 0..1 | string | Software product name including OS (e.g. Android, iOS) |
| version | SΣ | 0..1 | string | Software certified version or release number |
| endpoint | Σ | 1..1 | url | Actual message source address or id |
| focus | SΣ | 1..1 | Reference(DiagnosticReport - At-Home In-Vitro Results) | The focus of this message header is a DiagnosticReport. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| MessageHeader.event[x] | example | Pattern: LOINC code 96552-5 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MessageHeader | If 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-4 | error | MessageHeader | If 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-5 | error | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MessageHeader | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | Represents the At-Home In-Vitro Test Results being sent from an application server to a health authority. | |||||
| 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 | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | S | 0..1 | string | Receiving system OID | ||||
| 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) | ||||
| target | Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
| endpoint | SΣ | 1..1 | url | Actual destination address or id | ||||
| receiver | SΣ | 0..1 | Reference(US Core Organization Profile) | Intended "real-world" recipient for the data | ||||
| sender | SΣ | 0..1 | Reference(US Core Organization Profile) | Real world sender of the message | ||||
| 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 | S | 0..1 | string | Sending system OID | ||||
| Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
| sourceSoftwareVendorInfo | S | 0..1 | (Complex) | Source software information (vendor organization, binary id, intstall 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) | ||||
| software | Σ | 0..1 | string | Software product name including OS (e.g. Android, iOS) | ||||
| version | SΣ | 0..1 | string | Software certified version or release number | ||||
| contact | Σ | 0..1 | ContactPoint | Human contact for problems | ||||
| endpoint | Σ | 1..1 | url | Actual message source address or id | ||||
| 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 | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| MessageHeader.language | preferred | CommonLanguages
| ||||
| MessageHeader.event[x] | example | Pattern: LOINC code 96552-5 | ||||
| MessageHeader.reason | example | ExampleMessageReasonCodes | ||||
| MessageHeader.response.code | required | ResponseType |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from MessageHeader
Summary
Mandatory: 1 element
Must-Support: 14 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ Orders and Observations. Package hl7.fhir.us.home-lab-report#1.0.0 based on FHIR 4.0.1. Generated 2023-03-25
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change