This page is part of the electronic Case Reporting (eCR) (v1.0.0: STU 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
Definitions for the StructureDefinition-rr-communication Profile.
1. Communication | |
Definition | This Reportability Response Communication will be created in response to an electronic Initial Case Report Composition and 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:
|
Control | 0..* |
Must Support | true |
Invariants | Defined on this element dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.`div`.exists()) |
2. Communication.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 |
Type | string |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
3. Communication.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
4. Communication.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
5. Communication.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language. The codes SHOULD be taken from CommonLanguages Max Binding: AllLanguages |
Type | code |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
6. Communication.text | |
Definition | The narrative structure of a Reportability Response Comminication can take two different forms, depending on the processing status of the eICR Composition document to which it is a response. These forms are as follows:
|
Control | 1..1 |
Type | Narrative |
Must Support | true |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
7. Communication.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Control | 0..* |
Type | Resource |
Alternate Names | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
8. Communication.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on Communication.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
9. Communication.extension:reportabilityResponsePriority | |
SliceName | reportabilityResponsePriority |
Definition | Represents a priority for the reportability response communication overall. It has been calculated from the highest priority of any included External Resources or the highest priority of included conditions based on a separate, jurisdictionally developed priority list. This “communication”-level priority should be used for EHR workflow including notification, alerting, routing and queueing. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(RR_Priority_Extension) (Extension Type: CodeableConcept) |
Must Support | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
10. Communication.extension:relatesTo | |
SliceName | relatesTo |
Definition | Represents either a 'transforms' or a 'replaces' structure that this Communication is related to. |
Control | 0..2 This element is affected by the following invariants: ele-1 |
Type | Extension(Relates_To_Extension) (Extension Type: Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta) |
Must Support | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
11. Communication.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
12. Communication.identifier | |
Definition | Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..1 |
Type | Identifier |
Must Support | true |
Requirements | Allows identification of the communication as it is known by various participating systems and in a way that remains consistent across servers. |
Comments | This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number. |
Example | General:<valueIdentifier xmlns="http://hl7.org/fhir"> <system value="http://acme.org/identifiers"/> <value value="RR12346"/> </valueIdentifier> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
13. Communication.instantiatesCanonical | |
Definition | The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication. |
Control | 0..* |
Type | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
14. Communication.instantiatesUri | |
Definition | The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication. |
Control | 0..* |
Type | uri |
Comments | This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
15. Communication.basedOn | |
Definition | An order, proposal or plan fulfilled in whole or in part by this Communication. |
Control | 0..* |
Type | Reference(Resource) |
Alternate Names | fulfills |
Comments | This must point to some sort of a 'Request' resource, such as CarePlan, CommunicationRequest, ServiceRequest, MedicationRequest, etc. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
16. Communication.partOf | |
Definition | Part of this action. |
Control | 0..* |
Type | Reference(Resource) |
Alternate Names | container |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
17. Communication.inResponseTo | |
Definition | Prior communication that this communication is in response to. |
Control | 0..* |
Type | Reference(Communication) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
18. Communication.status | |
Definition | The status of the transmission. |
Control | 1..1 |
Binding | The status of the communication. The codes SHALL be taken from EventStatus |
Type | code |
Is Modifier | true |
Comments | This element is labeled as a modifier because the status contains the codes aborted and entered-in-error that mark the communication as not currently valid. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
19. Communication.statusReason | |
Definition | Captures the reason for the current state of the Communication. |
Control | 0..1 |
Binding | Codes for the reason why a communication did not happen. For example codes, see CommunicationNotDoneReason |
Type | CodeableConcept |
Alternate Names | Suspended Reason, Cancelled Reason |
Comments | This is generally only used for "exception" statuses such as "not-done", "suspended" or "aborted". The reason for performing the event at all is captured in reasonCode, not here. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
20. Communication.category | |
Definition | The type of message conveyed such as alert, notification, reminder, instruction, etc. |
Control | 1..1 |
Binding | Codes for general categories of communications such as alerts, instructions, etc. For example codes, see CommunicationCategory |
Type | CodeableConcept |
Must Support | true |
Comments | There may be multiple axes of categorization and one communication may serve multiple purposes. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="88085-6"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
21. Communication.priority | |
Definition | Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine. |
Control | 0..1 |
Binding | Codes indicating the relative importance of a communication. The codes SHALL be taken from RequestPriority |
Type | code |
Comments | Used to prioritize workflow (such as which communication to read first) when the communication is planned or in progress. |
Meaning if Missing | If missing, this communication should be treated with normal priority |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
22. Communication.medium | |
Definition | A channel that was used for this communication (e.g. email, fax). |
Control | 0..* |
Binding | Codes for communication mediums such as phone, fax, email, in person, etc. For example codes, see v3 Code System ParticipationMode |
Type | CodeableConcept |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
23. Communication.subject | |
Definition | The patient or group that was the focus of this communication. |
Control | 1..1 |
Type | Reference(Ecr_Patient) |
Must Support | true |
Alternate Names | patient |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
24. Communication.topic | |
Definition | Contains a short high-level description of the determination of reportability. This information can be used to route and prioritize Reportability Responses in a work queue or an email subject. |
Control | 1..1 |
Binding | Codes describing the purpose or content of the communication. For example codes, see CommunicationTopic |
Type | CodeableConcept |
Must Support | true |
Comments | Communication.topic.text can be used without any codings. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
25. Communication.topic.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
26. Communication.topic.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on Communication.topic.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
27. Communication.topic.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* |
Type | Coding |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
28. Communication.topic.text | |
Definition | Contains a short high-level description of the determination of reportability. |
Control | 1..1 |
Type | string |
Must Support | true |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Example | General:Public Health Reporting Communication: one or more conditions are reportable, or may be reportable to public health. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
29. Communication.about | |
Definition | Other resources that pertain to this communication and to which this communication should be associated. |
Control | 0..* |
Type | Reference(Resource) |
Comments | Don't use Communication.about element when a more specific element exists, such as basedOn or reasonReference. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
30. Communication.encounter | |
Definition | The encounter in which the eICR was triggered. |
Control | 0..1 |
Type | Reference(Eicr_Encounter) |
Must Support | true |
Comments | This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
31. Communication.sent | |
Definition | The time when this communication was sent. |
Control | 1..1 |
Type | dateTime |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
32. Communication.received | |
Definition | The time when this communication arrived at the destination. |
Control | 0..1 |
Type | dateTime |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
33. Communication.recipient | |
Definition | Reporting may be identified for multiple PHAs by the PHA system (or its intermediary) (because the patient's residence and the provider location are in separate jurisdictions) including other identified organization (such as an HIE) to which the eICR (if deemed reportable) and/or the Reportability Response will be routed. |
Control | 1..* |
Type | Reference(Ecr_Organization | USCorePractitionerProfile | Ecr_PractitionerRole) |
Must Support | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
34. Communication.sender | |
Definition | For the Reportability Response communication, this will most likely be the software that is generating the response, though this will not always the be case. |
Control | 1..1 |
Type | Reference(Device | Ecr_Organization | USCorePractitionerProfile | Ecr_PractitionerRole) |
Must Support | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
35. Communication.reasonCode | |
Definition | The reason or justification for the communication. |
Control | 0..* |
Binding | Codes for describing reasons for the occurrence of a communication. For example codes, see SNOMEDCTClinicalFindings |
Type | CodeableConcept |
Comments | Textual reasons can be captured using reasonCode.text. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
36. Communication.reasonReference | |
Definition | Indicates another resource whose existence justifies this communication. |
Control | 0..* |
Type | Reference(Condition | Observation | DiagnosticReport | DocumentReference) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
37. Communication.payload | |
Definition | Text, attachment(s), or resource(s) that was communicated to the recipient. |
Control | 0..* |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Communication.payload. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
38. Communication.payload.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
39. Communication.payload.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
40. Communication.payload.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
41. Communication.payload.content[x] | |
Definition | A communicated content (or for multi-part communications, one portion of the communication). |
Control | 1..1 |
Type | Choice of: string, Attachment, Reference(Resource) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
42. Communication.payload:sliceReportabilityResponseSummary | |
SliceName | sliceReportabilityResponseSummary |
Definition | This payload slice is present in the Reportabilty Response if the eICR was processed and is not present if the eICR was not processed. Contains a detailed text description of the reportable condition(s) including actions the provider needs to take, any supplemental information that may be required, and where the initial case report was sent. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
43. Communication.payload:sliceReportabilityResponseSummary.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 1..1 |
Type | string |
Must Support | true |
Fixed Value | reportability-response-summary |
44. Communication.payload:sliceReportabilityResponseSummary.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
45. Communication.payload:sliceReportabilityResponseSummary.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
46. Communication.payload:sliceReportabilityResponseSummary.content[x] | |
Definition | A communicated content (or for multi-part communications, one portion of the communication). |
Control | 1..1 |
Type | string |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
47. Communication.payload:sliceEICRInformation | |
SliceName | sliceEICRInformation |
Definition | This payload slice contains information about the eICR Document to which this Communication is a response. The date/time of receipt and a document reference are represented in the Electronic Initial Case Report Composition Profile (contained in the eICR Document Bundle) and the processing status of the eICR Document is contained in the eICR Processing Status profile. If the eICR Document was manually or alternately initiated by a healthcare provider, this is indicated by the presence of the Initiation Type eICR extension. This payload slice is always present in the Reportability Response Communication. The text element (narrative block) in this section is only populated and displayed when the eICR Document was not processed (eICR Processing Status/code="RRVS22", "eICR was not processed - error") and that text element contains the eICR processing status reason(s). |
Control | 1..* |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
48. Communication.payload:sliceEICRInformation.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 1..1 |
Type | string |
Must Support | true |
Fixed Value | eicr-information |
49. Communication.payload:sliceEICRInformation.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on Communication.payload.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
50. Communication.payload:sliceEICRInformation.extension:extensionEICRProcessingStatus | |
SliceName | extensionEICRProcessingStatus |
Definition | This extension constains processing status information about the eICR. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Extension(RR_Eicr_Processing_Status_Extension) (Extension Type: Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta) |
Must Support | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
51. Communication.payload:sliceEICRInformation.extension:extensionAlternatelyManuallyInitiatedEICR | |
SliceName | extensionAlternatelyManuallyInitiatedEICR |
Definition | The presence of this extension indicates whether or not the eICR CDA document for which this Reportability Response is a response, was either alternately or manually initiated. The eICR could also contain RCTC trigger codes (automatic trigger code initiation). |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(Eicr_Initiation_Type_Extension) (Extension Type: CodeableConcept) |
Must Support | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
52. Communication.payload:sliceEICRInformation.extension:extensionEICRReceiptTime | |
SliceName | extensionEICRReceiptTime |
Definition | This extension contains the date and time of eICR receipt. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(RR_Eicr_Receipt_Time_Extension) (Extension Type: dateTime) |
Must Support | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
53. Communication.payload:sliceEICRInformation.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
54. Communication.payload:sliceEICRInformation.content[x] | |
Definition | Reference to eICR Document Bundle or eICR CDA document. If Reference: 1. Use id for eICR Document Bundle id 2. Use display for eICR file name (or other identifying string): recommended primarily for dealing with eICR error cases. In the case where an eICR document is unreadable for some reason, it is possible that the only identifying information is the eICR filename (or other identifying string). If Attachment: 1. Use url for eICR Document id. 2. Use title for eICR file name (or other identifying string). |
Control | 1..1 |
Type | Choice of: Reference(Eicr_Document_Bundle), Attachment |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
55. Communication.payload:sliceRelevantReportableCondition | |
SliceName | sliceRelevantReportableCondition |
Definition | This payload slice is present in the Reportabilty Response if the eICR was processed and is not present if the eICR was not processed. It contains a Reportability Response PlanDefinition and repeats for each uniqe condition-PHA pair. |
Control | 0..* |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
56. Communication.payload:sliceRelevantReportableCondition.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 1..1 |
Type | string |
Must Support | true |
Fixed Value | relevant-reportable-condition |
57. Communication.payload:sliceRelevantReportableCondition.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
58. Communication.payload:sliceRelevantReportableCondition.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
59. Communication.payload:sliceRelevantReportableCondition.content[x] | |
Definition | A communicated content (or for multi-part communications, one portion of the communication). |
Control | 1..1 |
Type | Reference(RR_Relevant_Reportable_Condition_Plandefinition) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
60. Communication.note | |
Definition | Additional notes or commentary about the communication by the sender, receiver or other interested parties. |
Control | 0..* |
Type | Annotation |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |