Central Cancer Registry Reporting Content IG
1.0.0 - STU 1 United States of America flag

This page is part of the Making EHR Data MOre available for Research and Public Health (MedMorph) Central Cancer Registry Reporting Content IG (v1.0.0: STU1) 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: Central Cancer Registry Reporting Message Header

Official URL: http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/central-cancer-registry-reporting-messageheader Version: 1.0.0
Draft as of 2019-09-01 Computable Name: CentralCancerRegistryReportingMessageHeader
Other Identifiers: OID:2.16.840.1.113883.4.642.40.40.42.4

This is the MessageHeader Resource profile for the IG.

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..* USPublicHealthMessageHeader Central Cancer Registry Reporting MessageHeader
... source
.... name S 1..1 string Name of system
.... software S 1..1 string Name of software running the system
.... version S 1..1 string Version of software running

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..* USPublicHealthMessageHeader Central Cancer Registry Reporting MessageHeader
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension S 1..* Extension Extension
Slice: Unordered, Open by value:url
.... dataEncrypted S 0..1 boolean US Public Health Data Encrypted Extension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-data-encrypted-extension
.... reportInitiationType S 1..1 CodeableConcept Extension
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..* Extension Extensions that cannot be ignored
... destination SΣ 1..* BackboneElement Message destination application(s)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... endpoint SΣ 1..1 url Actual destination address or id
... sender SΣ 1..1 Reference(US Public Health Organization) Real world sender of the message
... source SΣ 1..1 BackboneElement Message source application
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name SΣ 1..1 string Name of system
.... software SΣ 1..1 string Name of software running the system
.... version SΣ 1..1 string Version of software running
.... endpoint SΣ 1..1 url Actual message source address or id
... reason SΣ 1..1 CodeableConcept The named event that gave rise to the message
Binding: US Public Health TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents

... response SΣ 0..1 BackboneElement If this is a reply to prior message
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier SΣ 1..1 id Id of original message
.... code SΣ 1..1 code ok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details SΣ 0..1 Reference(OperationOutcome) Specific list of hints/warnings/errors
... definition SΣ 0..1 canonical(US Public Health MessageDefinition) Link to the definition for this message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MessageHeader.event[x]extensibleUSPublicHealthMessageTypes
http://hl7.org/fhir/us/medmorph/ValueSet/us-ph-message-types
MessageHeader.reasonextensibleUSPublicHealthTriggerDefinitionNamedEvent
http://hl7.org/fhir/us/medmorph/ValueSet/us-ph-triggerdefinition-namedevent
MessageHeader.response.coderequiredResponseType
http://hl7.org/fhir/ValueSet/response-code|4.0.1
from the FHIR Standard

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..* USPublicHealthMessageHeader Central Cancer Registry Reporting MessageHeader
... 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
... Slices for extension S 1..* Extension Extension
Slice: Unordered, Open by value:url
.... dataEncrypted S 0..1 boolean US Public Health Data Encrypted Extension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-data-encrypted-extension
.... reportInitiationType S 1..1 CodeableConcept Extension
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..* Extension Extensions that cannot be ignored
... event[x] SΣ 1..1 Coding Types of messages being sent between systems
Binding: US Public Health Message Types (extensible): US Public Health Message Types ValueSet

... destination SΣ 1..* 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 Σ 0..1 string Name of system
.... target Σ 0..1 Reference(Device) Particular delivery destination within the destination
.... endpoint SΣ 1..1 url Actual destination address or id
.... receiver Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Intended "real-world" recipient for the data
... sender SΣ 1..1 Reference(US Public Health Organization) 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 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Σ 1..1 string Name of system
.... software SΣ 1..1 string Name of software running the system
.... version SΣ 1..1 string Version of software running
.... contact Σ 0..1 ContactPoint Human contact for problems
.... endpoint SΣ 1..1 url Actual message source address or id
... responsible Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Final responsibility for event
... reason SΣ 1..1 CodeableConcept The named event that gave rise to the message
Binding: US Public Health TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents

... response SΣ 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 SΣ 1..1 id Id of original message
.... code SΣ 1..1 code ok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details SΣ 0..1 Reference(OperationOutcome) Specific list of hints/warnings/errors
... focus Σ 0..* Reference(Resource) The actual content of the message
... definition SΣ 0..1 canonical(US Public Health MessageDefinition) Link to the definition for this message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MessageHeader.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MessageHeader.event[x]extensibleUSPublicHealthMessageTypes
http://hl7.org/fhir/us/medmorph/ValueSet/us-ph-message-types
MessageHeader.reasonextensibleUSPublicHealthTriggerDefinitionNamedEvent
http://hl7.org/fhir/us/medmorph/ValueSet/us-ph-triggerdefinition-namedevent
MessageHeader.response.coderequiredResponseType
http://hl7.org/fhir/ValueSet/response-code|4.0.1
from the FHIR Standard

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()

This structure is derived from USPublicHealthMessageHeader

Summary

Mandatory: 3 elements
Must-Support: 3 elements

Differential View

This structure is derived from USPublicHealthMessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..* USPublicHealthMessageHeader Central Cancer Registry Reporting MessageHeader
... source
.... name S 1..1 string Name of system
.... software S 1..1 string Name of software running the system
.... version S 1..1 string Version of software running

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..* USPublicHealthMessageHeader Central Cancer Registry Reporting MessageHeader
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension S 1..* Extension Extension
Slice: Unordered, Open by value:url
.... dataEncrypted S 0..1 boolean US Public Health Data Encrypted Extension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-data-encrypted-extension
.... reportInitiationType S 1..1 CodeableConcept Extension
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..* Extension Extensions that cannot be ignored
... destination SΣ 1..* BackboneElement Message destination application(s)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... endpoint SΣ 1..1 url Actual destination address or id
... sender SΣ 1..1 Reference(US Public Health Organization) Real world sender of the message
... source SΣ 1..1 BackboneElement Message source application
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name SΣ 1..1 string Name of system
.... software SΣ 1..1 string Name of software running the system
.... version SΣ 1..1 string Version of software running
.... endpoint SΣ 1..1 url Actual message source address or id
... reason SΣ 1..1 CodeableConcept The named event that gave rise to the message
Binding: US Public Health TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents

... response SΣ 0..1 BackboneElement If this is a reply to prior message
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier SΣ 1..1 id Id of original message
.... code SΣ 1..1 code ok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details SΣ 0..1 Reference(OperationOutcome) Specific list of hints/warnings/errors
... definition SΣ 0..1 canonical(US Public Health MessageDefinition) Link to the definition for this message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MessageHeader.event[x]extensibleUSPublicHealthMessageTypes
http://hl7.org/fhir/us/medmorph/ValueSet/us-ph-message-types
MessageHeader.reasonextensibleUSPublicHealthTriggerDefinitionNamedEvent
http://hl7.org/fhir/us/medmorph/ValueSet/us-ph-triggerdefinition-namedevent
MessageHeader.response.coderequiredResponseType
http://hl7.org/fhir/ValueSet/response-code|4.0.1
from the FHIR Standard

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..* USPublicHealthMessageHeader Central Cancer Registry Reporting MessageHeader
... 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
... Slices for extension S 1..* Extension Extension
Slice: Unordered, Open by value:url
.... dataEncrypted S 0..1 boolean US Public Health Data Encrypted Extension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-data-encrypted-extension
.... reportInitiationType S 1..1 CodeableConcept Extension
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..* Extension Extensions that cannot be ignored
... event[x] SΣ 1..1 Coding Types of messages being sent between systems
Binding: US Public Health Message Types (extensible): US Public Health Message Types ValueSet

... destination SΣ 1..* 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 Σ 0..1 string Name of system
.... target Σ 0..1 Reference(Device) Particular delivery destination within the destination
.... endpoint SΣ 1..1 url Actual destination address or id
.... receiver Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Intended "real-world" recipient for the data
... sender SΣ 1..1 Reference(US Public Health Organization) 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 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Σ 1..1 string Name of system
.... software SΣ 1..1 string Name of software running the system
.... version SΣ 1..1 string Version of software running
.... contact Σ 0..1 ContactPoint Human contact for problems
.... endpoint SΣ 1..1 url Actual message source address or id
... responsible Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Final responsibility for event
... reason SΣ 1..1 CodeableConcept The named event that gave rise to the message
Binding: US Public Health TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents

... response SΣ 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 SΣ 1..1 id Id of original message
.... code SΣ 1..1 code ok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details SΣ 0..1 Reference(OperationOutcome) Specific list of hints/warnings/errors
... focus Σ 0..* Reference(Resource) The actual content of the message
... definition SΣ 0..1 canonical(US Public Health MessageDefinition) Link to the definition for this message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MessageHeader.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MessageHeader.event[x]extensibleUSPublicHealthMessageTypes
http://hl7.org/fhir/us/medmorph/ValueSet/us-ph-message-types
MessageHeader.reasonextensibleUSPublicHealthTriggerDefinitionNamedEvent
http://hl7.org/fhir/us/medmorph/ValueSet/us-ph-triggerdefinition-namedevent
MessageHeader.response.coderequiredResponseType
http://hl7.org/fhir/ValueSet/response-code|4.0.1
from the FHIR Standard

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()

This structure is derived from USPublicHealthMessageHeader

Summary

Mandatory: 3 elements
Must-Support: 3 elements

 

Other representations of profile: CSV, Excel, Schematron