Cancer Pathology Data Sharing
1.0.0 - STU1 United States of America flag

Cancer Pathology Data Sharing, published by HL7 Orders and Observations 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/cancer-reporting/ and changes regularly. See the Directory of published versions

Resource Profile: US Pathology MessageHeader

Official URL: http://hl7.org/fhir/us/cancer-reporting/StructureDefinition/us-pathology-message-header Version: 1.0.0
Active as of 2023-08-18 Computable Name: USPathologyMessageHeader

Copyright/Legal:

This MessageHeader profile is expected to be used by systems when sending to public health registries. It is not expected and not appropriate to be used in any other cases, such as when information exchange between a pathology laboratory and a clinical EHR system. This IG supports both message bundle and transaction bundle to support both use cases.

Usage:

Formal Views of Profile Content

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

This structure is derived from USPublicHealthMessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*USPublicHealthMessageHeaderUS Public Health MessageHeader
... meta S0..1MetaMetadata about the resource
.... security 0..1CodingSecurity Labels applied to this resource
... event[x] 1..1CodingTypes of messages being sent between systems
Required Pattern: At least the following
.... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-messageheader-message-types
.... code1..1codeSymbol in syntax defined by the system
Fixed Value: cancer-report-message
... focus S1..1Reference(US Pathology Cancer Registry Content Bundle)The actual content of the message

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*USPublicHealthMessageHeaderUS Public Health MessageHeader
... meta SΣ0..1MetaMetadata about the resource
.... security Σ0..1CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension S1..*ExtensionExtension
Slice: Unordered, Open by value:url
... 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


Required Pattern: At least the following
.... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-messageheader-message-types
.... code1..1codeSymbol in syntax defined by the system
Fixed Value: cancer-report-message
... 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
... focus SΣ1..1Reference(US Pathology Cancer Registry Content Bundle)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 / Code
MessageHeader.meta.securityextensibleAll Security Labels
MessageHeader.event[x]extensiblePattern: cancer-report-message
MessageHeader.reasonextensibleUSPublicHealthTriggerDefinitionNamedEvent
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..*USPublicHealthMessageHeaderUS Public Health MessageHeader
... id Σ0..1idLogical id of this artifact
... meta SΣ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..1CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... 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


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/medmorph/CodeSystem/us-ph-messageheader-message-types
.... version0..1stringVersion of the system - if relevant
.... code1..1codeSymbol in syntax defined by the system
Fixed Value: cancer-report-message
.... display0..1stringRepresentation defined by the system
.... userSelected0..1booleanIf this coding was chosen directly by the user
... 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 SΣ1..1Reference(US Pathology Cancer Registry Content Bundle)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 / Code
MessageHeader.meta.securityextensibleAll Security Labels
MessageHeader.meta.tagexampleCommonTags
MessageHeader.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
MessageHeader.event[x]extensiblePattern: cancer-report-message
MessageHeader.reasonextensibleUSPublicHealthTriggerDefinitionNamedEvent
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()

This structure is derived from USPublicHealthMessageHeader

Summary

Mandatory: 1 element
Must-Support: 2 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from USPublicHealthMessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*USPublicHealthMessageHeaderUS Public Health MessageHeader
... meta S0..1MetaMetadata about the resource
.... security 0..1CodingSecurity Labels applied to this resource
... event[x] 1..1CodingTypes of messages being sent between systems
Required Pattern: At least the following
.... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-messageheader-message-types
.... code1..1codeSymbol in syntax defined by the system
Fixed Value: cancer-report-message
... focus S1..1Reference(US Pathology Cancer Registry Content Bundle)The actual content of the message

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*USPublicHealthMessageHeaderUS Public Health MessageHeader
... meta SΣ0..1MetaMetadata about the resource
.... security Σ0..1CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension S1..*ExtensionExtension
Slice: Unordered, Open by value:url
... 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


Required Pattern: At least the following
.... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-messageheader-message-types
.... code1..1codeSymbol in syntax defined by the system
Fixed Value: cancer-report-message
... 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
... focus SΣ1..1Reference(US Pathology Cancer Registry Content Bundle)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 / Code
MessageHeader.meta.securityextensibleAll Security Labels
MessageHeader.event[x]extensiblePattern: cancer-report-message
MessageHeader.reasonextensibleUSPublicHealthTriggerDefinitionNamedEvent
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..*USPublicHealthMessageHeaderUS Public Health MessageHeader
... id Σ0..1idLogical id of this artifact
... meta SΣ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..1CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... 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


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/medmorph/CodeSystem/us-ph-messageheader-message-types
.... version0..1stringVersion of the system - if relevant
.... code1..1codeSymbol in syntax defined by the system
Fixed Value: cancer-report-message
.... display0..1stringRepresentation defined by the system
.... userSelected0..1booleanIf this coding was chosen directly by the user
... 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 SΣ1..1Reference(US Pathology Cancer Registry Content Bundle)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 / Code
MessageHeader.meta.securityextensibleAll Security Labels
MessageHeader.meta.tagexampleCommonTags
MessageHeader.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
MessageHeader.event[x]extensiblePattern: cancer-report-message
MessageHeader.reasonextensibleUSPublicHealthTriggerDefinitionNamedEvent
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()

This structure is derived from USPublicHealthMessageHeader

Summary

Mandatory: 1 element
Must-Support: 2 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron