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
Official URL: http://hl7.org/fhir/us/cancer-reporting/StructureDefinition/us-pathology-message-header | Version: 1.0.0 | |||
Active as of 2022-11-28 | 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![]() |
---|---|---|---|---|
![]() ![]() | 0..* | USPublicHealthMessageHeader | US Public Health MessageHeader | |
![]() ![]() ![]() | S | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() ![]() | 0..1 | Coding | Security Labels applied to this resource | |
![]() ![]() ![]() | 1..1 | Coding | Code for the event this message represents or link to event definition Required Pattern: At least the following | |
![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-messageheader-message-types | |
![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: cancer-report-message | |
![]() ![]() ![]() | S | 1..1 | Reference(US Pathology Cancer Registry Content Bundle) | The actual content of the message |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | USPublicHealthMessageHeader | US Public Health MessageHeader | |
![]() ![]() ![]() | SΣ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() ![]() | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | S | 0..1 | boolean | Indicates whether the data in the content bundle is encrypted or not URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-dataEncrypted |
![]() ![]() ![]() | S | 1..1 | code | Indicates how messages should be processed URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-messageProcessingCategory Binding: MessageSignificanceCategory (required): The message processing requirements identified by the message |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | SΣ | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: US Public Health Message Types (extensible): Types of messages being sent between systems Required Pattern: At least the following |
![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-messageheader-message-types | |
![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: cancer-report-message | |
![]() ![]() ![]() | SΣ | 1..* | BackboneElement | Message destination application(s) |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | SΣ | 1..1 | url | Actual destination address or id |
![]() ![]() ![]() | SΣ | 1..1 | Reference(Organization) | Real world sender of the message |
![]() ![]() ![]() | SΣ | 1..1 | BackboneElement | Message source application |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | SΣ | 1..1 | url | Actual message source address or id |
![]() ![]() ![]() | SΣ | 1..1 | CodeableConcept | Cause of event Binding: US Public Health TriggerDefinition NamedEvent (extensible): The named event that gave rise to the message |
![]() ![]() ![]() | SΣ | 0..1 | BackboneElement | If this is a reply to prior message |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | SΣ | 1..1 | id | Id of original message |
![]() ![]() ![]() ![]() | SΣ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. |
![]() ![]() ![]() ![]() | SΣ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors |
![]() ![]() ![]() | SΣ | 1..1 | Reference(US Pathology Cancer Registry Content Bundle) | The actual content of the message |
![]() |
Path | Conformance | ValueSet / Code |
MessageHeader.meta.security | extensible | All Security Labels |
MessageHeader.event[x] | extensible | Pattern: cancer-report-message |
MessageHeader.reason | extensible | USPublicHealthTriggerDefinitionNamedEvent |
MessageHeader.response.code | required | ResponseType |
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![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | USPublicHealthMessageHeader | US Public Health MessageHeader | |||||
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | SΣ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() | Σ | 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". | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | S | 0..1 | boolean | Indicates whether the data in the content bundle is encrypted or not URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-dataEncrypted | ||||
![]() ![]() ![]() | S | 1..1 | code | Indicates how messages should be processed URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-messageProcessingCategory Binding: MessageSignificanceCategory (required): The message processing requirements identified by the message | ||||
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | SΣ | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: US Public Health Message Types (extensible): Types of messages being sent between systems Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-messageheader-message-types | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: cancer-report-message | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() | 0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() | SΣ | 1..* | BackboneElement | Message destination application(s) | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Name of system | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
![]() ![]() ![]() ![]() | SΣ | 1..1 | url | Actual destination address or id | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data | ||||
![]() ![]() ![]() | SΣ | 1..1 | Reference(Organization) | Real world sender of the message | ||||
![]() ![]() ![]() | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry | ||||
![]() ![]() ![]() | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision | ||||
![]() ![]() ![]() | SΣ | 1..1 | BackboneElement | Message source application | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Name of system | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Name of software running the system | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of software running | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | ContactPoint | Human contact for problems | ||||
![]() ![]() ![]() ![]() | SΣ | 1..1 | url | Actual message source address or id | ||||
![]() ![]() ![]() | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event | ||||
![]() ![]() ![]() | SΣ | 1..1 | CodeableConcept | Cause of event Binding: US Public Health TriggerDefinition NamedEvent (extensible): The named event that gave rise to the message | ||||
![]() ![]() ![]() | SΣ | 0..1 | BackboneElement | If this is a reply to prior message | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | SΣ | 1..1 | id | Id of original message | ||||
![]() ![]() ![]() ![]() | SΣ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | ||||
![]() ![]() ![]() | SΣ | 1..1 | Reference(US Pathology Cancer Registry Content Bundle) | The actual content of the message | ||||
![]() ![]() ![]() | Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message | ||||
![]() |
Path | Conformance | ValueSet / Code | ||||
MessageHeader.meta.security | extensible | All Security Labels | ||||
MessageHeader.meta.tag | example | CommonTags | ||||
MessageHeader.language | preferred | CommonLanguages
| ||||
MessageHeader.event[x] | extensible | Pattern: cancer-report-message | ||||
MessageHeader.reason | extensible | USPublicHealthTriggerDefinitionNamedEvent | ||||
MessageHeader.response.code | required | ResponseType |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from USPublicHealthMessageHeader
Differential View
This structure is derived from USPublicHealthMessageHeader
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | USPublicHealthMessageHeader | US Public Health MessageHeader | |
![]() ![]() ![]() | S | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() ![]() | 0..1 | Coding | Security Labels applied to this resource | |
![]() ![]() ![]() | 1..1 | Coding | Code for the event this message represents or link to event definition Required Pattern: At least the following | |
![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-messageheader-message-types | |
![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: cancer-report-message | |
![]() ![]() ![]() | S | 1..1 | Reference(US Pathology Cancer Registry Content Bundle) | The actual content of the message |
![]() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | USPublicHealthMessageHeader | US Public Health MessageHeader | |
![]() ![]() ![]() | SΣ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() ![]() | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | S | 0..1 | boolean | Indicates whether the data in the content bundle is encrypted or not URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-dataEncrypted |
![]() ![]() ![]() | S | 1..1 | code | Indicates how messages should be processed URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-messageProcessingCategory Binding: MessageSignificanceCategory (required): The message processing requirements identified by the message |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | SΣ | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: US Public Health Message Types (extensible): Types of messages being sent between systems Required Pattern: At least the following |
![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-messageheader-message-types | |
![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: cancer-report-message | |
![]() ![]() ![]() | SΣ | 1..* | BackboneElement | Message destination application(s) |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | SΣ | 1..1 | url | Actual destination address or id |
![]() ![]() ![]() | SΣ | 1..1 | Reference(Organization) | Real world sender of the message |
![]() ![]() ![]() | SΣ | 1..1 | BackboneElement | Message source application |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | SΣ | 1..1 | url | Actual message source address or id |
![]() ![]() ![]() | SΣ | 1..1 | CodeableConcept | Cause of event Binding: US Public Health TriggerDefinition NamedEvent (extensible): The named event that gave rise to the message |
![]() ![]() ![]() | SΣ | 0..1 | BackboneElement | If this is a reply to prior message |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | SΣ | 1..1 | id | Id of original message |
![]() ![]() ![]() ![]() | SΣ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. |
![]() ![]() ![]() ![]() | SΣ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors |
![]() ![]() ![]() | SΣ | 1..1 | Reference(US Pathology Cancer Registry Content Bundle) | The actual content of the message |
![]() |
Path | Conformance | ValueSet / Code |
MessageHeader.meta.security | extensible | All Security Labels |
MessageHeader.event[x] | extensible | Pattern: cancer-report-message |
MessageHeader.reason | extensible | USPublicHealthTriggerDefinitionNamedEvent |
MessageHeader.response.code | required | ResponseType |
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![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | USPublicHealthMessageHeader | US Public Health MessageHeader | |||||
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | SΣ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() | Σ | 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". | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | S | 0..1 | boolean | Indicates whether the data in the content bundle is encrypted or not URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-dataEncrypted | ||||
![]() ![]() ![]() | S | 1..1 | code | Indicates how messages should be processed URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-messageProcessingCategory Binding: MessageSignificanceCategory (required): The message processing requirements identified by the message | ||||
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | SΣ | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: US Public Health Message Types (extensible): Types of messages being sent between systems Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-messageheader-message-types | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: cancer-report-message | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() | 0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() | SΣ | 1..* | BackboneElement | Message destination application(s) | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Name of system | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
![]() ![]() ![]() ![]() | SΣ | 1..1 | url | Actual destination address or id | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data | ||||
![]() ![]() ![]() | SΣ | 1..1 | Reference(Organization) | Real world sender of the message | ||||
![]() ![]() ![]() | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry | ||||
![]() ![]() ![]() | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision | ||||
![]() ![]() ![]() | SΣ | 1..1 | BackboneElement | Message source application | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Name of system | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Name of software running the system | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of software running | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | ContactPoint | Human contact for problems | ||||
![]() ![]() ![]() ![]() | SΣ | 1..1 | url | Actual message source address or id | ||||
![]() ![]() ![]() | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event | ||||
![]() ![]() ![]() | SΣ | 1..1 | CodeableConcept | Cause of event Binding: US Public Health TriggerDefinition NamedEvent (extensible): The named event that gave rise to the message | ||||
![]() ![]() ![]() | SΣ | 0..1 | BackboneElement | If this is a reply to prior message | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | SΣ | 1..1 | id | Id of original message | ||||
![]() ![]() ![]() ![]() | SΣ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | ||||
![]() ![]() ![]() | SΣ | 1..1 | Reference(US Pathology Cancer Registry Content Bundle) | The actual content of the message | ||||
![]() ![]() ![]() | Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message | ||||
![]() |
Path | Conformance | ValueSet / Code | ||||
MessageHeader.meta.security | extensible | All Security Labels | ||||
MessageHeader.meta.tag | example | CommonTags | ||||
MessageHeader.language | preferred | CommonLanguages
| ||||
MessageHeader.event[x] | extensible | Pattern: cancer-report-message | ||||
MessageHeader.reason | extensible | USPublicHealthTriggerDefinitionNamedEvent | ||||
MessageHeader.response.code | required | ResponseType |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from USPublicHealthMessageHeader
Other representations of profile: CSV, Excel, Schematron