This page is part of the electronic Case Reporting (eCR) (v1.1.0: STU 2 on FHIR R4 Ballot 1) based on FHIR R4. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions
Defining URL: | http://hl7.org/fhir/us/ecr/StructureDefinition/rr-communication |
Version: | 1.1.0 |
Name: | RR_Communication |
Title: | Reportability Response Communication |
Status: | Active as of 2020-12-16T19:27:50+00:00 |
Definition: | This Communication profile represents the Reportability Response that will be created in response to an electronic Initial Case Report Composition. |
Publisher: | HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm) |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/us/ecr/StructureDefinition/rr-communication
The sharing of the Reportability Response with clinical care will serve several functions, including to:
A Reportability Response will also, when requested, be shared with the responsible PHAs (when they have not constructed it) for their internal use, so they understand what has been shared with clinical care and, and to monitor/audit decision support algorithm effectivesness and implementation. When a condition is considered reportable to more than one PHA, the Reportability Response can be helpful in communicating reporting that has been done to other PHAs.
The Reportability Response Communication is also structured to allow:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Communication
Summary
Mandatory: 13 elements (2 nested mandatory elements)
Must-Support: 23 elements
Fixed Value: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from Communication
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Communication | S | 0..* | Communication | Reportability Response Communication |
text | S | 1..1 | Narrative | Text narrative should conform to requirements laid out on the Reportability_Response_Narrative_Guidance page |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
rr-priority-extension | S | 0..1 | CodeableConcept | Reportability Response Priority URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension Binding: Reportability Priority (eCR) (extensible): This value set contains codes that describe the reportability priority in a Reportability Response. |
relates-to-extension | S | 0..2 | (Complex) | Represents either a 'transforms' or a 'replaces' structure that this Communication is related to. URL: http://hl7.org/fhir/us/ecr/StructureDefinition/relates-to-extension |
identifier | S | 1..1 | Identifier | Unique identifier Example General: {"system":"http://acme.org/identifiers","value":"RR12346"} |
category | S | 1..1 | CodeableConcept | Message category Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 88085-6 | |
subject | S | 1..1 | Reference(US Public Health Patient) | Patient |
topic | S | 1..1 | CodeableConcept | Reportability Response Subject |
text | S | 1..1 | string | Reportability Response Subject text Example General: Public Health Reporting Communication: one or more conditions are reportable, or may be reportable to public health. |
encounter | S | 0..1 | Reference(US Public Health Encounter) | eICR Encounter |
sent | 1..1 | dateTime | When sent | |
recipient | S | 1..* | Reference(US Public Health Organization | US Core Practitioner Profile | US Public Health PractitionerRole) | Reportability Response recipients |
sender | S | 1..1 | Reference(Device | US Public Health Organization | US Core Practitioner Profile | US Public Health PractitionerRole) | Author |
payload | 1..* | (Slice Definition) | Message payload Slice: Unordered, Open by value:id | |
payload:sliceReportabilityResponseSummary | S | 0..1 | BackboneElement | Reportability Response Summary |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: reportability-response-summary |
content[x] | S | 1..1 | string | Reportability Response Summary text Example General: Your organization electronically submitted an initial case report to determine if reporting to public health is needed for a patient. "Zika virus disease (disorder)" is reportable to "State Department of Health". An initial case report was sent to "State Department of Health". Additional information may be required for this report. |
payload:sliceEICRInformation | S | 1..* | BackboneElement | Electronic Initial Case Report Information |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: eicr-information |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
rr-eicr-processing-status-extension | S | 1..1 | (Complex) | eICR Processing Status URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-extension |
eicr-initiation-type-extension | S | 0..1 | CodeableConcept | Alternately or Manually Initiated eICR URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-initiation-type-extension Binding: eICR Initiation (extensible): This value set contains codes that describe alternative eICR initiation types. |
rr-eicr-receipt-time-extension | S | 0..1 | dateTime | Date and time of eICR receipt URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-receipt-time-extension |
content[x] | S | 1..1 | Reference to eICR Document Bundle or eICR CDA document | |
contentReference | Reference(eICR Document Bundle) | |||
contentAttachment | Attachment | |||
payload:sliceRelevantReportableCondition | S | 0..* | BackboneElement | Relevant Reportable Condition |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: relevant-reportable-condition |
content[x] | S | 1..1 | Reference(Relevant Reportable Condition PlanDefinition) | Reference to Relevant Reportable Condition PlanDefinition |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Communication | S | 0..* | Communication | Reportability Response Communication |
id | Σ | 0..1 | string | 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 |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
text | S | 1..1 | Narrative | Text narrative should conform to requirements laid out on the Reportability_Response_Narrative_Guidance page |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
rr-priority-extension | S | 0..1 | CodeableConcept | Reportability Response Priority URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension Binding: Reportability Priority (eCR) (extensible): This value set contains codes that describe the reportability priority in a Reportability Response. |
relates-to-extension | S | 0..2 | (Complex) | Represents either a 'transforms' or a 'replaces' structure that this Communication is related to. URL: http://hl7.org/fhir/us/ecr/StructureDefinition/relates-to-extension |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 1..1 | Identifier | Unique identifier Example General: {"system":"http://acme.org/identifiers","value":"RR12346"} |
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition |
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition |
basedOn | Σ | 0..* | Reference(Resource) | Request fulfilled by this communication |
partOf | Σ | 0..* | Reference(Resource) | Part of this action |
inResponseTo | 0..* | Reference(Communication) | Reply to | |
status | ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. |
statusReason | Σ | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen. |
category | S | 1..1 | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc. Required Pattern: At least the following |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
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://loinc.org | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 88085-6 | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication. |
medium | 0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |
subject | SΣ | 1..1 | Reference(US Public Health Patient) | Patient |
topic | S | 1..1 | CodeableConcept | Reportability Response Subject Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
text | SΣ | 1..1 | string | Reportability Response Subject text Example General: Public Health Reporting Communication: one or more conditions are reportable, or may be reportable to public health. |
about | 0..* | Reference(Resource) | Resources that pertain to this communication | |
encounter | SΣ | 0..1 | Reference(US Public Health Encounter) | eICR Encounter |
sent | 1..1 | dateTime | When sent | |
received | 0..1 | dateTime | When received | |
recipient | S | 1..* | Reference(US Public Health Organization | US Core Practitioner Profile | US Public Health PractitionerRole) | Reportability Response recipients |
sender | S | 1..1 | Reference(Device | US Public Health Organization | US Core Practitioner Profile | US Public Health PractitionerRole) | Author |
reasonCode | Σ | 0..* | CodeableConcept | Indication for message Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication. |
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why was communication done? |
payload | 1..* | (Slice Definition) | Message payload Slice: Unordered, Open by value:id | |
payload:All Slices | Content/Rules for all slices | |||
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 |
content[x] | 1..1 | Message part content | ||
contentString | string | |||
contentAttachment | Attachment | |||
contentReference | Reference(Resource) | |||
payload:sliceReportabilityResponseSummary | S | 0..1 | BackboneElement | Reportability Response Summary |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: reportability-response-summary |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
content[x] | S | 1..1 | string | Reportability Response Summary text Example General: Your organization electronically submitted an initial case report to determine if reporting to public health is needed for a patient. "Zika virus disease (disorder)" is reportable to "State Department of Health". An initial case report was sent to "State Department of Health". Additional information may be required for this report. |
payload:sliceEICRInformation | S | 1..* | BackboneElement | Electronic Initial Case Report Information |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: eicr-information |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
rr-eicr-processing-status-extension | S | 1..1 | (Complex) | eICR Processing Status URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-extension |
eicr-initiation-type-extension | S | 0..1 | CodeableConcept | Alternately or Manually Initiated eICR URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-initiation-type-extension Binding: eICR Initiation (extensible): This value set contains codes that describe alternative eICR initiation types. |
rr-eicr-receipt-time-extension | S | 0..1 | dateTime | Date and time of eICR receipt URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-receipt-time-extension |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
content[x] | S | 1..1 | Reference to eICR Document Bundle or eICR CDA document | |
contentReference | Reference(eICR Document Bundle) | |||
contentAttachment | Attachment | |||
payload:sliceRelevantReportableCondition | S | 0..* | BackboneElement | Relevant Reportable Condition |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: relevant-reportable-condition |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
content[x] | S | 1..1 | Reference(Relevant Reportable Condition PlanDefinition) | Reference to Relevant Reportable Condition PlanDefinition |
note | 0..* | Annotation | Comments made about the communication | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Communication | 0..* | Communication | Reportability Response Communication | |
text | 1..1 | Narrative | Text narrative should conform to requirements laid out on the Reportability_Response_Narrative_Guidance page | |
rr-priority-extension | 0..1 | CodeableConcept | Reportability Response Priority URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension Binding: Reportability Priority (eCR) (extensible): This value set contains codes that describe the reportability priority in a Reportability Response. | |
relates-to-extension | 0..2 | (Complex) | Represents either a 'transforms' or a 'replaces' structure that this Communication is related to. URL: http://hl7.org/fhir/us/ecr/StructureDefinition/relates-to-extension | |
identifier | Σ | 1..1 | Identifier | Unique identifier |
category | 1..1 | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc. Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 88085-6 | |
subject | Σ | 1..1 | Reference(US Public Health Patient) | Patient |
topic | 1..1 | CodeableConcept | Reportability Response Subject Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication. | |
text | Σ | 1..1 | string | Reportability Response Subject text |
encounter | Σ | 0..1 | Reference(US Public Health Encounter) | eICR Encounter |
recipient | 1..* | Reference(US Public Health Organization | US Core Practitioner Profile | US Public Health PractitionerRole) | Reportability Response recipients | |
sender | 1..1 | Reference(Device | US Public Health Organization | US Core Practitioner Profile | US Public Health PractitionerRole) | Author | |
payload:sliceReportabilityResponseSummary | 0..1 | BackboneElement | Reportability Response Summary | |
id | 1..1 | string | Unique id for inter-element referencing Fixed Value: reportability-response-summary | |
content[x] | 1..1 | string | Reportability Response Summary text | |
payload:sliceEICRInformation | 1..* | BackboneElement | Electronic Initial Case Report Information | |
id | 1..1 | string | Unique id for inter-element referencing Fixed Value: eicr-information | |
rr-eicr-processing-status-extension | 1..1 | (Complex) | eICR Processing Status URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-extension | |
eicr-initiation-type-extension | 0..1 | CodeableConcept | Alternately or Manually Initiated eICR URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-initiation-type-extension Binding: eICR Initiation (extensible): This value set contains codes that describe alternative eICR initiation types. | |
rr-eicr-receipt-time-extension | 0..1 | dateTime | Date and time of eICR receipt URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-receipt-time-extension | |
content[x] | 1..1 | Reference to eICR Document Bundle or eICR CDA document | ||
contentReference | Reference(eICR Document Bundle) | |||
contentAttachment | Attachment | |||
payload:sliceRelevantReportableCondition | 0..* | BackboneElement | Relevant Reportable Condition | |
id | 1..1 | string | Unique id for inter-element referencing Fixed Value: relevant-reportable-condition | |
content[x] | 1..1 | Reference(Relevant Reportable Condition PlanDefinition) | Reference to Relevant Reportable Condition PlanDefinition | |
Documentation for this format |
This structure is derived from Communication
Summary
Mandatory: 13 elements (2 nested mandatory elements)
Must-Support: 23 elements
Fixed Value: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Communication
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Communication | S | 0..* | Communication | Reportability Response Communication |
text | S | 1..1 | Narrative | Text narrative should conform to requirements laid out on the Reportability_Response_Narrative_Guidance page |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
rr-priority-extension | S | 0..1 | CodeableConcept | Reportability Response Priority URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension Binding: Reportability Priority (eCR) (extensible): This value set contains codes that describe the reportability priority in a Reportability Response. |
relates-to-extension | S | 0..2 | (Complex) | Represents either a 'transforms' or a 'replaces' structure that this Communication is related to. URL: http://hl7.org/fhir/us/ecr/StructureDefinition/relates-to-extension |
identifier | S | 1..1 | Identifier | Unique identifier Example General: {"system":"http://acme.org/identifiers","value":"RR12346"} |
category | S | 1..1 | CodeableConcept | Message category Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 88085-6 | |
subject | S | 1..1 | Reference(US Public Health Patient) | Patient |
topic | S | 1..1 | CodeableConcept | Reportability Response Subject |
text | S | 1..1 | string | Reportability Response Subject text Example General: Public Health Reporting Communication: one or more conditions are reportable, or may be reportable to public health. |
encounter | S | 0..1 | Reference(US Public Health Encounter) | eICR Encounter |
sent | 1..1 | dateTime | When sent | |
recipient | S | 1..* | Reference(US Public Health Organization | US Core Practitioner Profile | US Public Health PractitionerRole) | Reportability Response recipients |
sender | S | 1..1 | Reference(Device | US Public Health Organization | US Core Practitioner Profile | US Public Health PractitionerRole) | Author |
payload | 1..* | (Slice Definition) | Message payload Slice: Unordered, Open by value:id | |
payload:sliceReportabilityResponseSummary | S | 0..1 | BackboneElement | Reportability Response Summary |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: reportability-response-summary |
content[x] | S | 1..1 | string | Reportability Response Summary text Example General: Your organization electronically submitted an initial case report to determine if reporting to public health is needed for a patient. "Zika virus disease (disorder)" is reportable to "State Department of Health". An initial case report was sent to "State Department of Health". Additional information may be required for this report. |
payload:sliceEICRInformation | S | 1..* | BackboneElement | Electronic Initial Case Report Information |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: eicr-information |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
rr-eicr-processing-status-extension | S | 1..1 | (Complex) | eICR Processing Status URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-extension |
eicr-initiation-type-extension | S | 0..1 | CodeableConcept | Alternately or Manually Initiated eICR URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-initiation-type-extension Binding: eICR Initiation (extensible): This value set contains codes that describe alternative eICR initiation types. |
rr-eicr-receipt-time-extension | S | 0..1 | dateTime | Date and time of eICR receipt URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-receipt-time-extension |
content[x] | S | 1..1 | Reference to eICR Document Bundle or eICR CDA document | |
contentReference | Reference(eICR Document Bundle) | |||
contentAttachment | Attachment | |||
payload:sliceRelevantReportableCondition | S | 0..* | BackboneElement | Relevant Reportable Condition |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: relevant-reportable-condition |
content[x] | S | 1..1 | Reference(Relevant Reportable Condition PlanDefinition) | Reference to Relevant Reportable Condition PlanDefinition |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Communication | S | 0..* | Communication | Reportability Response Communication |
id | Σ | 0..1 | string | 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 |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
text | S | 1..1 | Narrative | Text narrative should conform to requirements laid out on the Reportability_Response_Narrative_Guidance page |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
rr-priority-extension | S | 0..1 | CodeableConcept | Reportability Response Priority URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension Binding: Reportability Priority (eCR) (extensible): This value set contains codes that describe the reportability priority in a Reportability Response. |
relates-to-extension | S | 0..2 | (Complex) | Represents either a 'transforms' or a 'replaces' structure that this Communication is related to. URL: http://hl7.org/fhir/us/ecr/StructureDefinition/relates-to-extension |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 1..1 | Identifier | Unique identifier Example General: {"system":"http://acme.org/identifiers","value":"RR12346"} |
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition |
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition |
basedOn | Σ | 0..* | Reference(Resource) | Request fulfilled by this communication |
partOf | Σ | 0..* | Reference(Resource) | Part of this action |
inResponseTo | 0..* | Reference(Communication) | Reply to | |
status | ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. |
statusReason | Σ | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen. |
category | S | 1..1 | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc. Required Pattern: At least the following |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
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://loinc.org | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 88085-6 | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication. |
medium | 0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |
subject | SΣ | 1..1 | Reference(US Public Health Patient) | Patient |
topic | S | 1..1 | CodeableConcept | Reportability Response Subject Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
text | SΣ | 1..1 | string | Reportability Response Subject text Example General: Public Health Reporting Communication: one or more conditions are reportable, or may be reportable to public health. |
about | 0..* | Reference(Resource) | Resources that pertain to this communication | |
encounter | SΣ | 0..1 | Reference(US Public Health Encounter) | eICR Encounter |
sent | 1..1 | dateTime | When sent | |
received | 0..1 | dateTime | When received | |
recipient | S | 1..* | Reference(US Public Health Organization | US Core Practitioner Profile | US Public Health PractitionerRole) | Reportability Response recipients |
sender | S | 1..1 | Reference(Device | US Public Health Organization | US Core Practitioner Profile | US Public Health PractitionerRole) | Author |
reasonCode | Σ | 0..* | CodeableConcept | Indication for message Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication. |
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why was communication done? |
payload | 1..* | (Slice Definition) | Message payload Slice: Unordered, Open by value:id | |
payload:All Slices | Content/Rules for all slices | |||
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 |
content[x] | 1..1 | Message part content | ||
contentString | string | |||
contentAttachment | Attachment | |||
contentReference | Reference(Resource) | |||
payload:sliceReportabilityResponseSummary | S | 0..1 | BackboneElement | Reportability Response Summary |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: reportability-response-summary |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
content[x] | S | 1..1 | string | Reportability Response Summary text Example General: Your organization electronically submitted an initial case report to determine if reporting to public health is needed for a patient. "Zika virus disease (disorder)" is reportable to "State Department of Health". An initial case report was sent to "State Department of Health". Additional information may be required for this report. |
payload:sliceEICRInformation | S | 1..* | BackboneElement | Electronic Initial Case Report Information |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: eicr-information |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
rr-eicr-processing-status-extension | S | 1..1 | (Complex) | eICR Processing Status URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-extension |
eicr-initiation-type-extension | S | 0..1 | CodeableConcept | Alternately or Manually Initiated eICR URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-initiation-type-extension Binding: eICR Initiation (extensible): This value set contains codes that describe alternative eICR initiation types. |
rr-eicr-receipt-time-extension | S | 0..1 | dateTime | Date and time of eICR receipt URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-receipt-time-extension |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
content[x] | S | 1..1 | Reference to eICR Document Bundle or eICR CDA document | |
contentReference | Reference(eICR Document Bundle) | |||
contentAttachment | Attachment | |||
payload:sliceRelevantReportableCondition | S | 0..* | BackboneElement | Relevant Reportable Condition |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: relevant-reportable-condition |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
content[x] | S | 1..1 | Reference(Relevant Reportable Condition PlanDefinition) | Reference to Relevant Reportable Condition PlanDefinition |
note | 0..* | Annotation | Comments made about the communication | |
Documentation for this format |
Other representations of profile: Schematron
Path | Conformance | ValueSet / Code |
Communication.language | preferred | CommonLanguages Max Binding: AllLanguages |
Communication.status | required | EventStatus |
Communication.statusReason | example | CommunicationNotDoneReason |
Communication.category | example | Pattern: LOINC code 88085-6 |
Communication.priority | required | RequestPriority |
Communication.medium | example | ParticipationMode |
Communication.topic | example | CommunicationTopic |
Communication.reasonCode | example | SNOMEDCTClinicalFindings |
Id | Path | Details | Requirements |
dom-2 | Communication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | Communication | 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 | Communication | 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 | Communication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | Communication | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | Communication.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Communication.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Communication.extension:reportabilityResponsePriority | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Communication.extension:reportabilityResponsePriority | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Communication.extension:relatesTo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Communication.extension:relatesTo | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Communication.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Communication.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Communication.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.instantiatesCanonical | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.instantiatesUri | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.basedOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.partOf | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.inResponseTo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.statusReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.priority | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.medium | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.topic | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.topic.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Communication.topic.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Communication.topic.coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.topic.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.about | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.sent | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.received | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.recipient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.sender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.reasonCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.reasonReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.payload | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.payload.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Communication.payload.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Communication.payload.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Communication.payload.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Communication.payload.content[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.payload:sliceReportabilityResponseSummary | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.payload:sliceReportabilityResponseSummary.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Communication.payload:sliceReportabilityResponseSummary.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Communication.payload:sliceReportabilityResponseSummary.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Communication.payload:sliceReportabilityResponseSummary.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Communication.payload:sliceReportabilityResponseSummary.content[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.payload:sliceEICRInformation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.payload:sliceEICRInformation.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Communication.payload:sliceEICRInformation.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Communication.payload:sliceEICRInformation.extension:extensionEICRProcessingStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Communication.payload:sliceEICRInformation.extension:extensionEICRProcessingStatus | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Communication.payload:sliceEICRInformation.extension:extensionAlternatelyManuallyInitiatedEICR | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Communication.payload:sliceEICRInformation.extension:extensionAlternatelyManuallyInitiatedEICR | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Communication.payload:sliceEICRInformation.extension:extensionEICRReceiptTime | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Communication.payload:sliceEICRInformation.extension:extensionEICRReceiptTime | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Communication.payload:sliceEICRInformation.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Communication.payload:sliceEICRInformation.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Communication.payload:sliceEICRInformation.content[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.payload:sliceRelevantReportableCondition | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.payload:sliceRelevantReportableCondition.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Communication.payload:sliceRelevantReportableCondition.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Communication.payload:sliceRelevantReportableCondition.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Communication.payload:sliceRelevantReportableCondition.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Communication.payload:sliceRelevantReportableCondition.content[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |