This page is part of the electronic Case Reporting (eCR) (v0.2.0: STU 1 Ballot 2) based on FHIR R3. 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.
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 com-1: Not Done Reason can only be specified if NotDone is "true" (: notDone or notDoneReason.exists().not()) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty()) 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 (: contained.where(('#'+id in %resource.descendants().reference).not()).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()) |
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 | id |
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. |
Communication.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
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. |
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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
Communication.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language. The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable |
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). |
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 This element is affected by the following invariants: dom-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 in formation is added later. |
Invariants | Defined on this element nar-1: Text narrative SHOULD conform to requirements laid out on the Narrative Guidance tab (: not(tested)) |
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. |
Communication.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Communication.extension ([CanonicalType[http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-priority]]) | |
Definition | Priority given to the communication or one or more external resources. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: CodeableConcept) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
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. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
Communication.identifier | |
Definition | Identifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 1..1 |
Type | Identifier |
Must Support | true |
Example | General:<valueIdentifier xmlns="http://hl7.org/fhir"> <system value="http://acme.org/identifiers"/> <value value="RR12346"/> </valueIdentifier> |
Communication.definition | |
Definition | A protocol, guideline, or other definition that was adhered to in whole or in part by this communication event. |
Control | 0..* |
Type | Reference(PlanDefinition | ActivityDefinition) |
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, ReferralRequest, MedicationRequest, etc. |
Communication.partOf | |
Definition | Part of this action. |
Control | 0..* |
Type | Reference(Resource) |
Alternate Names | container |
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. |
Communication.notDone | |
Definition | If true, indicates that the described communication event did not actually occur. |
Control | 0..1 |
Type | boolean |
Is Modifier | true |
Requirements | Creating a Communication where notDone is true is intended for situations where there's a need for a specific statement in the record about something not being done. If the need is merely to indicate that a request wasn't fulfilled, that should be handled using Task. |
Comments | This element is labeled as a modifier because it marks the communication as a communication that did not occur. The more attributes are populated, the more constrained the negated statement is. |
Communication.notDoneReason | |
Definition | Describes why the communication event did not occur in coded and/or textual form. |
Control | 0..1 This element is affected by the following invariants: com-1 |
Binding | Codes for the reason why a communication was not done. For example codes, see CommunicationNotDoneReason |
Type | CodeableConcept |
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, instruction, 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"/> <display value="Reportability Response Report Public Health"/> </coding> </valueCodeableConcept> |
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 |
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 |
Example | General:<valueReference xmlns="http://hl7.org/fhir"> <reference value="Patient/ecr-patient-eve-everywoman"/> <display value="Eve Everywoman"/> </valueReference> |
Communication.recipient | |
Definition | The entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time). |
Control | 1..* |
Type | Reference(Organization | Practitioner | PractitionerRole) |
Must Support | true |
Comments | 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. |
Example | General:<valueReference xmlns="http://hl7.org/fhir"> <reference value="PractitionerRole/ecr-practitionerrole-henry-seven"/> <display value="Henry Seven, MD"/> </valueReference> |
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 |
Type | Reference(Resource) |
Must Support | true |
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 |
Communication.topic.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
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. |
Communication.topic.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Control | 0..0 This element is affected by the following invariants: ref-1 |
Type | string |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Communication.topic.identifier | |
Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..0 |
Type | Identifier |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. |
Communication.topic.display | |
Definition | Contains a short high-level description of the determination of reportability. |
Control | 1..1 |
Type | string |
Must Support | true |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Example | General:Public Health Reporting Communication: one or more conditions are reportable, or may be reportable to public health. |
Communication.context | |
Definition | The encounter in which the eICR was triggered. |
Control | 0..1 |
Type | Reference(eicr-encounter) |
Must Support | true |
Alternate Names | encounter |
Communication.sent | |
Definition | The time when this communication was sent. |
Control | 1..1 |
Type | dateTime |
Communication.received | |
Definition | The time when this communication arrived at the destination. |
Control | 0..1 |
Type | dateTime |
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(Organization | Practitioner) |
Must Support | true |
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 SNOMED CT Clinical Findings |
Type | CodeableConcept |
Comments | Textual reasons can be caprued using reasonCode.text. |
Communication.reasonReference | |
Definition | Indicates another resource whose existence justifies this communication. |
Control | 0..* |
Type | Reference(Condition | Observation) |
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() | (children().count() > id.count())) |
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 |
Communication.payload.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
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] |
Communication.payload(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() | (children().count() > id.count())) |
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 | 1..1 |
Type | string |
Must Support | true |
Fixed Value | reportability-response-summary |
Communication.payload.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
Communication.payload.contentString(contentString) | |
Definition | 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 | 1..1 |
Type | string |
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. |
Communication.payload(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() | (children().count() > id.count())) |
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 | 1..1 |
Type | string |
Must Support | true |
Fixed Value | relevant-reportable-condition |
Communication.payload.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
Communication.payload.contentReference(contentReference) | |
Definition | A communicated content (or for multi-part communications, one portion of the communication). |
Control | 1..1 |
Type | Reference(rr-relevant-reportable-condition-plandefinition) |
Communication.payload(sliceEICRInformation) | |
Definition | This payload contains information about the eICR Composition to which this Communication is a response. The date/time of receipt and a document reference are represented in the referenced Electronic Initial Case Report Composition Profile and the processing status of the eICR Composition is contained in the eICR Processing Status profile. If the eICR Composition was manually initiated by a healthcare provider, this is indicated by the presence of the Manually Initiated eICR extension. This payload is always present in the Reportability Response Communication. The text element (narrative block) in this section is only populated and displayed when the eICR CDA 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() | (children().count() > id.count())) |
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 | 1..1 |
Type | string |
Must Support | true |
Fixed Value | eicr-information |
Communication.payload.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Communication.payload.extension ([CanonicalType[http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-eicr-processing-status]]) | |
Definition | This extension indicates the eICR processing status. If the eICR was not processed or was processed with a warning, the reason will be contained in the eICR Processing Status Reason. If there is any output from a validator, that output will be contained in the eICR Validation Output. If any of the trigger codes used to generate the eICR are from an outdated version of the RCTC or the codes are marked as inactive in the latest version of the RCTC, these are flagged and and the eICR Processing Status Reason Detail will hold the details of the outdated and expected versions of the RCTC. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Communication.payload.extension.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-processing-status |
Communication.payload.extension.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Communication.payload.extension.extension(eICRProcessingStatus) | |
Definition | An Extension |
Control | 1..1 |
Type | Extension |
Communication.payload.extension.extension.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 |
Communication.payload.extension.extension.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
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. |
Communication.payload.extension.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | eICRProcessingStatus |
Communication.payload.extension.extension.valueReference(valueReference) | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..1 |
Type | Reference(rr-eicr-processing-status) |
Communication.payload.extension.extension(eICRValidationOutput) | |
Definition | Contains eICR validation output - this could be the actual output from a validator, or a link to a validation output file |
Control | 0..* |
Type | Extension |
Communication.payload.extension.extension.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 |
Communication.payload.extension.extension.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
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. |
Communication.payload.extension.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | eICRValidationOutput |
Communication.payload.extension.extension.value[x] | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 1..1 |
Type | Choice of: markdown, string, Attachment |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Communication.payload.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-eicr-processing-status |
Communication.payload.extension.value[x] | |
Definition | Contains eICR validation output - this could be the actual output from a validator, or a link to a validation output file |
Control | 0..0 |
Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Communication.payload.extension ([CanonicalType[http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-manually-initiated-eicr]]) | |
Definition | This extension indicates whether or not the eICR CDA document for which this Reportability Response is a response, was manually initiated by the provider. The eICR could also contain RCTC trigger codes. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: boolean) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Communication.payload.extension.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 | manually-initiated-eicr |
Communication.payload.extension.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
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. |
Communication.payload.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-manually-initiated-eicr |
Communication.payload.extension.valueBoolean(valueBoolean) | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 1..1 |
Type | boolean |
Communication.payload.extension ([CanonicalType[http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-eicr-receipt-time]]) | |
Definition | Date and time of eICR receipt |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: dateTime) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
Communication.payload.contentReference(contentReference) | |
Definition | A communicated content (or for multi-part communications, one portion of the communication). |
Control | 1..1 |
Type | Reference(eicr-composition) |
Communication.payload.contentReference.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 |
Communication.payload.contentReference.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
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. |
Communication.payload.contentReference.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Control | 0..1 This element is affected by the following invariants: ref-1 |
Type | string |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Communication.payload.contentReference.identifier | |
Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
Must Support | true |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. |
Communication.payload.contentReference.display | |
Definition | The filename (or other identifying string) is 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). |
Control | 0..1 |
Type | string |
Must Support | true |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Example | General:eicr-composition-zika.xml |
Communication.note | |
Definition | Additional notes or commentary about the communication by the sender, receiver or other interested parties. |
Control | 0..* |
Type | Annotation |