Cancer Pathology Data Sharing
1.0.1 - STU 1.0.1
Cancer Pathology Data Sharing
1.0.1 - STU 1.0.1
This page is part of the Sharing eCC Data from Pathology Labs to EHR (v1.0.1: STU 1) based on FHIR (HL7® FHIR® Standard) 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/cancer-reporting/StructureDefinition/us-pathology-message-header | Version: 1.0.1 | |||
| Active as of 2024-04-16 | 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USPublicHealthMessageHeader
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MessageHeader |
0..* | USPublicHealthMessageHeader | US Public Health MessageHeader | |
  meta |
S | 0..1 | Meta | Metadata about the resource |
  security |
0..1 | Coding | Security Labels applied to this resource | |
 event[x] |
1..1 | Coding | Types of messages being sent between systems Required Pattern: At least the following | |
  system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-messageheader-message-types | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: cancer-report-message | |
 focus |
S | 1..1 | Reference(US Pathology Cancer Registry Content Bundle) | The actual content of the message |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader |
0..* | USPublicHealthMessageHeader | US Public Health MessageHeader | |
| meta |
SΣ | 0..1 | Meta | Metadata about the resource |
| security |
Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
 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 |
| 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 Required Pattern: At least the following |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-messageheader-message-types | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: cancer-report-message | |
| 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 |
| 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 |
| focus |
SΣ | 1..1 | Reference(US Pathology Cancer Registry Content Bundle) | The actual content of the message |
| definition |
SΣ | 0..1 | canonical(US Public Health MessageDefinition) | Link to the definition for this message |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| MessageHeader.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | |
| MessageHeader.event[x] | extensible | Pattern: cancer-report-messagehttp://hl7.org/fhir/us/medmorph/ValueSet/us-ph-message-types | |
| MessageHeader.reason | extensible | USPublicHealthTriggerDefinitionNamedEventhttp://hl7.org/fhir/us/medmorph/ValueSet/us-ph-triggerdefinition-namedevent | |
| MessageHeader.response.code | required | ResponseTypehttp://hl7.org/fhir/ValueSet/response-code|4.0.1from the FHIR Standard |
| 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..* | USPublicHealthMessageHeader | US Public Health MessageHeader | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
SΣ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag |
Σ | 0..* | Coding | Tags 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..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 | |||||
| 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 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-messageheader-message-types | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: cancer-report-message | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| 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 |
Σ | 0..1 | string | Name of system | ||||
| software |
Σ | 0..1 | string | Name of software running the system | ||||
| version |
Σ | 0..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 |
SΣ | 1..1 | Reference(US Pathology Cancer Registry Content Bundle) | The actual content of the message | ||||
| definition |
SΣ | 0..1 | canonical(US Public Health MessageDefinition) | Link to the definition for this message | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| MessageHeader.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| MessageHeader.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| MessageHeader.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| MessageHeader.event[x] | extensible | Pattern: cancer-report-messagehttp://hl7.org/fhir/us/medmorph/ValueSet/us-ph-message-types | ||||
| MessageHeader.reason | extensible | USPublicHealthTriggerDefinitionNamedEventhttp://hl7.org/fhir/us/medmorph/ValueSet/us-ph-triggerdefinition-namedevent | ||||
| MessageHeader.response.code | required | ResponseTypehttp://hl7.org/fhir/ValueSet/response-code|4.0.1from the FHIR Standard |
| 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() |
This structure is derived from USPublicHealthMessageHeader
Differential View
This structure is derived from USPublicHealthMessageHeader
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader |
0..* | USPublicHealthMessageHeader | US Public Health MessageHeader | |
| meta |
S | 0..1 | Meta | Metadata about the resource |
| security |
0..1 | Coding | Security Labels applied to this resource | |
| event[x] |
1..1 | Coding | Types of messages being sent between systems Required Pattern: At least the following | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-messageheader-message-types | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: cancer-report-message | |
| focus |
S | 1..1 | Reference(US Pathology Cancer Registry Content Bundle) | The actual content of the message |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader |
0..* | USPublicHealthMessageHeader | US Public Health MessageHeader | |
| meta |
SΣ | 0..1 | Meta | Metadata about the resource |
| security |
Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| 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 |
| 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 Required Pattern: At least the following |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-messageheader-message-types | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: cancer-report-message | |
| 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 |
| 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 |
| focus |
SΣ | 1..1 | Reference(US Pathology Cancer Registry Content Bundle) | The actual content of the message |
| definition |
SΣ | 0..1 | canonical(US Public Health MessageDefinition) | Link to the definition for this message |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| MessageHeader.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | |
| MessageHeader.event[x] | extensible | Pattern: cancer-report-messagehttp://hl7.org/fhir/us/medmorph/ValueSet/us-ph-message-types | |
| MessageHeader.reason | extensible | USPublicHealthTriggerDefinitionNamedEventhttp://hl7.org/fhir/us/medmorph/ValueSet/us-ph-triggerdefinition-namedevent | |
| MessageHeader.response.code | required | ResponseTypehttp://hl7.org/fhir/ValueSet/response-code|4.0.1from the FHIR Standard |
| 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..* | USPublicHealthMessageHeader | US Public Health MessageHeader | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
SΣ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag |
Σ | 0..* | Coding | Tags 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..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 | |||||
| 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 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-messageheader-message-types | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: cancer-report-message | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| 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 |
Σ | 0..1 | string | Name of system | ||||
| software |
Σ | 0..1 | string | Name of software running the system | ||||
| version |
Σ | 0..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 |
SΣ | 1..1 | Reference(US Pathology Cancer Registry Content Bundle) | The actual content of the message | ||||
| definition |
SΣ | 0..1 | canonical(US Public Health MessageDefinition) | Link to the definition for this message | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| MessageHeader.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| MessageHeader.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| MessageHeader.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| MessageHeader.event[x] | extensible | Pattern: cancer-report-messagehttp://hl7.org/fhir/us/medmorph/ValueSet/us-ph-message-types | ||||
| MessageHeader.reason | extensible | USPublicHealthTriggerDefinitionNamedEventhttp://hl7.org/fhir/us/medmorph/ValueSet/us-ph-triggerdefinition-namedevent | ||||
| MessageHeader.response.code | required | ResponseTypehttp://hl7.org/fhir/ValueSet/response-code|4.0.1from the FHIR Standard |
| 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() |
This structure is derived from USPublicHealthMessageHeader
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International / Orders and Observations. Package hl7.fhir.us.cancer-reporting#1.0.1 based on FHIR 4.0.1. Generated 2024-04-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change