At-Home In-Vitro Test Report
1.0.0-ballot - Ballot US

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

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

Official URL: https://hl7.org/fhir/us/home-lab-report/StructureDefinition/MessageHeader-at-home-in-vitro-test-results Version: 1.0.0-ballot
Active as of 2022-08-08 Computable Name: MessageHeaderAtHomeInVitroTestResults

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

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..*MessageHeaderRepresents the At-Home In-Vitro Test Results being sent from an application server to a health authority.
... event[x] S1..1CodingAt-Home In-Vitro Test Results
Required Pattern: At least the following
.... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/home-lab-report/CodeSystem/codesystem-at-home-in-vitro-test
.... code1..1codeSymbol in syntax defined by the system
Fixed Value: at-home-in-vitro-test-result-report
... destination S0..*BackboneElementMessage destination application(s)
.... id S0..1stringReceiving system OID
.... name S0..1stringReceiving system namespace (name of destination application)
.... receiver S0..1Reference(US Core Organization Profile)Intended "real-world" recipient for the data
... sender S0..1Reference(US Core Organization Profile)Real world sender of the message
.... id S0..1stringSending system OID
.... Slices for extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... sourceSoftwareVendorInfo S0..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 S0..1stringSending system namespace (name of app)
.... software 0..1stringSoftware product name including OS (e.g. Android, iOS)
.... version S0..1stringSoftware certified version or release number
... focus S0..1Reference(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..*MessageHeaderRepresents the At-Home In-Vitro Test Results being sent from an application server to a health authority.
... 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
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... event[x] SΣ1..1CodingAt-Home In-Vitro Test Results
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/home-lab-report/CodeSystem/codesystem-at-home-in-vitro-test
.... version0..1stringVersion of the system - if relevant
.... code1..1codeSymbol in syntax defined by the system
Fixed Value: at-home-in-vitro-test-result-report
.... display0..1stringRepresentation defined by the system
.... userSelected0..1booleanIf this coding was chosen directly by the user
... destination SΣ0..*BackboneElementMessage destination application(s)
.... id S0..1stringReceiving system OID
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name SΣ0..1stringReceiving system namespace (name of destination application)
.... target Σ0..1Reference(Device)Particular delivery destination within the destination
.... endpoint Σ1..1urlActual destination address or id
.... receiver SΣ0..1Reference(US Core Organization Profile)Intended "real-world" recipient for the data
... sender SΣ0..1Reference(US Core Organization Profile)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 S0..1stringSending system OID
.... Slices for extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... sourceSoftwareVendorInfo S0..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..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name SΣ0..1stringSending system namespace (name of app)
.... software Σ0..1stringSoftware product name including OS (e.g. Android, iOS)
.... version SΣ0..1stringSoftware certified version or release number
.... contact Σ0..1ContactPointHuman contact for problems
.... endpoint Σ1..1urlActual message source address or id
... responsible Σ0..1Reference(Practitioner | PractitionerRole | Organization)Final responsibility for event
... reason Σ0..1CodeableConceptCause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.

... response Σ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 Σ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 SΣ0..1Reference(DiagnosticReport - At-Home In-Vitro Results)The focus of this message header is a DiagnosticReport.
... definition Σ0..1canonical(MessageDefinition)Link to the definition for this message

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderRepresents the At-Home In-Vitro Test Results being sent from an application server to a health authority.
... event[x] Σ1..1CodingAt-Home In-Vitro Test Results
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.


Required Pattern: At least the following
.... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/home-lab-report/CodeSystem/codesystem-at-home-in-vitro-test
.... code1..1codeSymbol in syntax defined by the system
Fixed Value: at-home-in-vitro-test-result-report
... destination Σ0..*BackboneElementMessage destination application(s)
.... id 0..1stringReceiving system OID
.... name Σ0..1stringReceiving system namespace (name of destination application)
.... receiver Σ0..1Reference(US Core Organization Profile)Intended "real-world" recipient for the data
... sender Σ0..1Reference(US Core Organization Profile)Real world sender of the message
.... id 0..1stringSending system OID
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... sourceSoftwareVendorInfo 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 Σ0..1stringSending system namespace (name of app)
.... version Σ0..1stringSoftware certified version or release number
... focus Σ0..1Reference(DiagnosticReport - At-Home In-Vitro Results)The focus of this message header is a DiagnosticReport.

doco Documentation for this format

Differential View

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderRepresents the At-Home In-Vitro Test Results being sent from an application server to a health authority.
... event[x] S1..1CodingAt-Home In-Vitro Test Results
Required Pattern: At least the following
.... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/home-lab-report/CodeSystem/codesystem-at-home-in-vitro-test
.... code1..1codeSymbol in syntax defined by the system
Fixed Value: at-home-in-vitro-test-result-report
... destination S0..*BackboneElementMessage destination application(s)
.... id S0..1stringReceiving system OID
.... name S0..1stringReceiving system namespace (name of destination application)
.... receiver S0..1Reference(US Core Organization Profile)Intended "real-world" recipient for the data
... sender S0..1Reference(US Core Organization Profile)Real world sender of the message
.... id S0..1stringSending system OID
.... Slices for extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... sourceSoftwareVendorInfo S0..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 S0..1stringSending system namespace (name of app)
.... software 0..1stringSoftware product name including OS (e.g. Android, iOS)
.... version S0..1stringSoftware certified version or release number
... focus S0..1Reference(DiagnosticReport - At-Home In-Vitro Results)The focus of this message header is a DiagnosticReport.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderRepresents the At-Home In-Vitro Test Results being sent from an application server to a health authority.
... 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
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... event[x] SΣ1..1CodingAt-Home In-Vitro Test Results
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/home-lab-report/CodeSystem/codesystem-at-home-in-vitro-test
.... version0..1stringVersion of the system - if relevant
.... code1..1codeSymbol in syntax defined by the system
Fixed Value: at-home-in-vitro-test-result-report
.... display0..1stringRepresentation defined by the system
.... userSelected0..1booleanIf this coding was chosen directly by the user
... destination SΣ0..*BackboneElementMessage destination application(s)
.... id S0..1stringReceiving system OID
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name SΣ0..1stringReceiving system namespace (name of destination application)
.... target Σ0..1Reference(Device)Particular delivery destination within the destination
.... endpoint Σ1..1urlActual destination address or id
.... receiver SΣ0..1Reference(US Core Organization Profile)Intended "real-world" recipient for the data
... sender SΣ0..1Reference(US Core Organization Profile)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 S0..1stringSending system OID
.... Slices for extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... sourceSoftwareVendorInfo S0..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..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name SΣ0..1stringSending system namespace (name of app)
.... software Σ0..1stringSoftware product name including OS (e.g. Android, iOS)
.... version SΣ0..1stringSoftware certified version or release number
.... contact Σ0..1ContactPointHuman contact for problems
.... endpoint Σ1..1urlActual message source address or id
... responsible Σ0..1Reference(Practitioner | PractitionerRole | Organization)Final responsibility for event
... reason Σ0..1CodeableConceptCause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.

... response Σ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 Σ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 SΣ0..1Reference(DiagnosticReport - At-Home In-Vitro Results)The focus of this message header is a DiagnosticReport.
... 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 / Code
MessageHeader.languagepreferredCommonLanguages
Max Binding: AllLanguages
MessageHeader.event[x]examplePattern: at-home-in-vitro-test-result-report
MessageHeader.reasonexampleExampleMessageReasonCodes
MessageHeader.response.coderequiredResponseType

Constraints

IdGradePathDetailsRequirements
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-1errorMessageHeader.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMessageHeader.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMessageHeader.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMessageHeader.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMessageHeader.event[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.destinationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.destination.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMessageHeader.destination.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMessageHeader.destination.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMessageHeader.destination.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMessageHeader.destination.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.destination.targetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.destination.endpointAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.destination.receiverAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.senderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.entererAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.authorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.sourceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.source.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMessageHeader.source.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMessageHeader.source.extension:sourceSoftwareVendorInfoAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMessageHeader.source.extension:sourceSoftwareVendorInfoMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMessageHeader.source.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMessageHeader.source.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMessageHeader.source.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.source.softwareAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.source.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.source.contactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.source.endpointAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.responsibleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.reasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.responseAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.response.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMessageHeader.response.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMessageHeader.response.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMessageHeader.response.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMessageHeader.response.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.response.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.response.detailsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.focusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.definitionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())