{
"description": "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: \\n\\n- Communicate the reportability status, for the responsible PHA(s)of each condition included in the electronic Initial Case Report (eICR) \\n- Identify who (a PHA or an intermediary) prepared the Reportability Response \\n- Indicate whether the eICR has been sent to one or more PHA(s) \\n- Identify which PHA(s) has/have been sent the eICR \\n- Provide contact information for the responsible PHA(s) \\n- Provide suggested or required clinical follow-up activities from the responsible PHA(s), including any additional reporting needs or infection control activities \\n- Provide access to clinical support resources suggested by the responsible PHA(s) for identified reportable conditions \\n- Confirm eICR receipt and processing \\n\\nA 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. \\n\\nThe Reportability Response Communication is also structured to allow: \\n\\n- Notification, alerting, routing and queueing in work or message management systems for healthcare personnel \\n- Dynamic and static URIs for supplemental data collection and the provision of information resources",
"_filename": "StructureDefinition-rr-communication.json",
"package_name": "hl7.fhir.us.ecr",
"date": "2018-08-21T15:50:01+10:00",
"derivation": "constraint",
"publisher": null,
"fhirVersion": "3.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "US",
"system": "urn:iso:std:iso:3166",
"display": "United States of America"
} ]
} ],
"name": "rr-communication",
"mapping": [ {
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Mapping",
"identity": "workflow"
}, {
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "Communication",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "Reportability Response Communication",
"package_version": "0.2.0",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-1",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.text.empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()"
}, {
"key": "com-1",
"human": "Not Done Reason can only be specified if NotDone is \"true\"",
"xpath": "f:notDone/@value=true() or not(exists(f:notDoneReason))",
"source": "Communication",
"severity": "error",
"expression": "notDone or notDoneReason.exists().not()"
} ],
"path": "Communication",
"min": 0,
"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: \n\n- Communicate the reportability status, for the responsible PHA(s)of each condition included in the electronic Initial Case Report (eICR) \n- Identify who (a PHA or an intermediary) prepared the Reportability Response \n- Indicate whether the eICR has been sent to one or more PHA(s) \n- Identify which PHA(s) has/have been sent the eICR \n- Provide contact information for the responsible PHA(s) \n- Provide suggested or required clinical follow-up activities from the responsible PHA(s), including any additional reporting needs or infection control activities \n- Provide access to clinical support resources suggested by the responsible PHA(s) for identified reportable conditions \n- Confirm eICR receipt and processing \n\nA 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. \n\nThe Reportability Response Communication is also structured to allow: \n\n- Notification, alerting, routing and queueing in work or message management systems for healthcare personnel \n- Dynamic and static URIs for supplemental data collection and the provision of information resources",
"short": "Reportability Response Communication",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "Event",
"identity": "workflow"
}, {
"map": "workflow.encounter",
"identity": "w5"
}, {
"map": "Reportability Response Document (RR)",
"identity": "cda-rr"
} ],
"mustSupport": true,
"max": "*",
"id": "Communication",
"base": {
"max": "*",
"min": 0,
"path": "Communication"
}
}, {
"path": "Communication.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"short": "Logical id of this artifact",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "Communication.id",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"path": "Communication.meta",
"min": 0,
"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.",
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "Communication.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"path": "Communication.implicitRules",
"min": 0,
"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.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Communication.implicitRules",
"comment": "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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isSummary": true
}, {
"path": "Communication.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"max": "1",
"id": "Communication.language",
"comment": "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).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
}
}, {
"constraint": [ {
"key": "nar-1",
"human": "Text narrative SHOULD conform to requirements laid out on the Narrative Guidance tab",
"severity": "error",
"expression": "not(tested)"
} ],
"path": "Communication.text",
"min": 1,
"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: \n\n- If the eICR was processed, then the narrative text will be populated with data from Communication.topic, Communication.payload[Reportability Response Summary], Communication.payload[Relevant Reportable Condition], and Communication.payload[Electronic Initial Case Report Information] \n\n- If the eICR was not processed and has errors, then the narrative text will only be populated with data from Communication.payload[Electronic Initial Case Report Information]",
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"mustSupport": true,
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "Communication.text",
"condition": [ "dom-1" ],
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
}
}, {
"path": "Communication.contained",
"min": 0,
"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.",
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "Communication.contained",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
}
}, {
"path": "Communication.extension",
"min": 0,
"definition": "An Extension",
"short": "Extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Communication.extension",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Communication.extension",
"min": 0,
"definition": "Rrepresents 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.\r\nThis “communication”-level priority should be used for EHR workflow including notification, alerting, routing and queueing.",
"isModifier": false,
"short": "Reportability Response Priority",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-priority"
} ],
"mustSupport": true,
"sliceName": "reportabilityResponsePriority",
"max": "1",
"id": "Communication.extension:reportabilityResponsePriority",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"path": "Communication.modifierExtension",
"min": 0,
"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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Communication.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
}
}, {
"path": "Communication.identifier",
"min": 1,
"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).",
"short": "Unique identifier",
"mapping": [ {
"map": "Event.identifier",
"identity": "workflow"
}, {
"map": "id",
"identity": "w5"
}, {
"map": "Reportability Response Document (RR)/id",
"identity": "cda-rr"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": true,
"max": "1",
"id": "Communication.identifier",
"example": [ {
"label": "General",
"valueIdentifier": {
"value": "RR12346",
"system": "http://acme.org/identifiers"
}
} ],
"base": {
"max": "*",
"min": 0,
"path": "Communication.identifier"
},
"isSummary": true
}, {
"path": "Communication.definition",
"min": 0,
"definition": "A protocol, guideline, or other definition that was adhered to in whole or in part by this communication event.",
"short": "Instantiates protocol or definition",
"mapping": [ {
"map": "Event.definition",
"identity": "workflow"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/PlanDefinition"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ActivityDefinition"
} ],
"max": "*",
"id": "Communication.definition",
"base": {
"max": "*",
"min": 0,
"path": "Communication.definition"
},
"isSummary": true
}, {
"path": "Communication.basedOn",
"min": 0,
"definition": "An order, proposal or plan fulfilled in whole or in part by this Communication.",
"short": "Request fulfilled by this communication",
"mapping": [ {
"map": "Event.basedOn",
"identity": "workflow"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
} ],
"alias": [ "fulfills" ],
"max": "*",
"id": "Communication.basedOn",
"comment": "This must point to some sort of a 'Request' resource, such as CarePlan, CommunicationRequest, ReferralRequest, MedicationRequest, etc.",
"base": {
"max": "*",
"min": 0,
"path": "Communication.basedOn"
},
"isSummary": true
}, {
"path": "Communication.partOf",
"min": 0,
"definition": "Part of this action.",
"short": "Part of this action",
"mapping": [ {
"map": "Event.partOf",
"identity": "workflow"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
} ],
"alias": [ "container" ],
"max": "*",
"id": "Communication.partOf",
"base": {
"max": "*",
"min": 0,
"path": "Communication.partOf"
},
"isSummary": true
}, {
"path": "Communication.status",
"min": 1,
"definition": "The status of the transmission.",
"isModifier": true,
"short": "preparation | in-progress | suspended | aborted | completed | entered-in-error",
"mapping": [ {
"map": "Event.status",
"identity": "workflow"
}, {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationStatus"
} ],
"description": "The status of the communication.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/event-status"
}
},
"max": "1",
"id": "Communication.status",
"comment": "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.",
"base": {
"max": "1",
"min": 1,
"path": "Communication.status"
},
"isSummary": true
}, {
"path": "Communication.notDone",
"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.",
"min": 0,
"definition": "If true, indicates that the described communication event did not actually occur.",
"isModifier": true,
"short": "Communication did not occur",
"mapping": [ {
"map": "Event.notDone",
"identity": "workflow"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Communication.notDone",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Communication.notDone"
},
"isSummary": true
}, {
"path": "Communication.notDoneReason",
"min": 0,
"definition": "Describes why the communication event did not occur in coded and/or textual form.",
"short": "Why communication did not occur",
"mapping": [ {
"map": "Event.notDoneReason",
"identity": "workflow"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationNotDoneReason"
} ],
"description": "Codes for the reason why a communication was not done.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/communication-not-done-reason"
}
},
"max": "1",
"id": "Communication.notDoneReason",
"condition": [ "com-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Communication.notDoneReason"
},
"isSummary": true
}, {
"path": "Communication.category",
"min": 1,
"definition": "The type of message conveyed such as alert, notification, reminder, instruction, etc.",
"short": "Message category",
"mapping": [ {
"map": "Event.code",
"identity": "workflow"
}, {
"map": "class",
"identity": "w5"
}, {
"map": "Reportability Response/code",
"identity": "cda-rr"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationCategory"
} ],
"description": "Codes for general categories of communications such as alerts, instruction, etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/communication-category"
}
},
"max": "1",
"id": "Communication.category",
"comment": "There may be multiple axes of categorization and one communication may serve multiple purposes.",
"patternCodeableConcept": {
"coding": [ {
"code": "88085-6",
"system": "http://loinc.org",
"display": "Reportability Response Report Public Health"
} ]
},
"base": {
"max": "*",
"min": 0,
"path": "Communication.category"
}
}, {
"path": "Communication.medium",
"min": 0,
"definition": "A channel that was used for this communication (e.g. email, fax).",
"short": "A channel of communication",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationMedium"
} ],
"description": "Codes for communication mediums such as phone, fax, email, in person, etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-ParticipationMode"
}
},
"max": "*",
"id": "Communication.medium",
"base": {
"max": "*",
"min": 0,
"path": "Communication.medium"
}
}, {
"path": "Communication.subject",
"min": 1,
"definition": "The patient or group that was the focus of this communication.",
"short": "Patient",
"mapping": [ {
"map": "Event.subject",
"identity": "workflow"
}, {
"map": "who.focus",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/ecr/StructureDefinition/ecr-patient"
} ],
"mustSupport": true,
"alias": [ "patient" ],
"max": "1",
"id": "Communication.subject",
"example": [ {
"label": "General",
"valueReference": {
"display": "Eve Everywoman",
"reference": "Patient/ecr-patient-eve-everywoman"
}
} ],
"base": {
"max": "1",
"min": 0,
"path": "Communication.subject"
},
"isSummary": true
}, {
"path": "Communication.recipient",
"min": 1,
"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).",
"short": "Message recipient",
"mapping": [ {
"map": "who.focus",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/PractitionerRole"
} ],
"mustSupport": true,
"max": "*",
"id": "Communication.recipient",
"comment": "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": [ {
"label": "General",
"valueReference": {
"display": "Henry Seven, MD",
"reference": "PractitionerRole/ecr-practitionerrole-henry-seven"
}
} ],
"base": {
"max": "*",
"min": 0,
"path": "Communication.recipient"
}
}, {
"path": "Communication.topic",
"min": 1,
"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.",
"short": "Reportability Response Subject",
"mapping": [ {
"map": "context",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
} ],
"mustSupport": true,
"max": "1",
"id": "Communication.topic",
"base": {
"max": "*",
"min": 0,
"path": "Communication.topic"
}
}, {
"path": "Communication.topic.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Communication.topic.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Communication.topic.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Communication.topic.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Communication.topic.reference",
"min": 0,
"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.",
"short": "Literal reference, Relative, internal or absolute URL",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "0",
"id": "Communication.topic.reference",
"condition": [ "ref-1" ],
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.reference"
},
"isSummary": true
}, {
"path": "Communication.topic.identifier",
"min": 0,
"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.",
"short": "Logical reference, when literal reference is not known",
"mapping": [ {
"map": ".identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "0",
"id": "Communication.topic.identifier",
"comment": "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. \n\nWhen 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\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.identifier"
},
"isSummary": true
}, {
"path": "Communication.topic.display",
"min": 1,
"definition": "Contains a short high-level description of the determination of reportability.",
"short": "Reportability Response Subject text",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Communication.topic.display",
"comment": "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": [ {
"label": "General",
"valueString": "Public Health Reporting Communication: one or more conditions are reportable, or may be reportable to public health."
} ],
"base": {
"max": "1",
"min": 0,
"path": "Reference.display"
},
"isSummary": true
}, {
"path": "Communication.context",
"min": 0,
"definition": "The encounter in which the eICR was triggered.",
"short": "eICR Encounter",
"mapping": [ {
"map": "Event.context",
"identity": "workflow"
}, {
"map": "context",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-encounter"
} ],
"mustSupport": true,
"alias": [ "encounter" ],
"max": "1",
"id": "Communication.context",
"base": {
"max": "1",
"min": 0,
"path": "Communication.context"
},
"isSummary": true
}, {
"path": "Communication.sent",
"min": 1,
"definition": "The time when this communication was sent.",
"short": "When sent",
"mapping": [ {
"map": "Event.occurrenceDateTime (Invariant: maps to either sent OR received)",
"identity": "workflow"
}, {
"map": "when.init",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "Communication.sent",
"base": {
"max": "1",
"min": 0,
"path": "Communication.sent"
}
}, {
"path": "Communication.received",
"min": 0,
"definition": "The time when this communication arrived at the destination.",
"short": "When received",
"mapping": [ {
"map": "Event.occurrenceDateTime (Invariant: maps to either sent OR received)",
"identity": "workflow"
}, {
"map": "when.done",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "Communication.received",
"base": {
"max": "1",
"min": 0,
"path": "Communication.received"
}
}, {
"path": "Communication.sender",
"min": 1,
"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.",
"short": "Author",
"mapping": [ {
"map": "Event.performer.actor",
"identity": "workflow"
}, {
"map": "who.actor",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
} ],
"mustSupport": true,
"max": "1",
"id": "Communication.sender",
"base": {
"max": "1",
"min": 0,
"path": "Communication.sender"
}
}, {
"path": "Communication.reasonCode",
"min": 0,
"definition": "The reason or justification for the communication.",
"short": "Indication for message",
"mapping": [ {
"map": "Event.reasonCodableConcept",
"identity": "workflow"
}, {
"map": ".reasonCode",
"identity": "rim"
}, {
"map": "why",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationReason"
} ],
"description": "Codes for describing reasons for the occurrence of a communication.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/clinical-findings"
}
},
"max": "*",
"id": "Communication.reasonCode",
"comment": "Textual reasons can be caprued using reasonCode.text.",
"base": {
"max": "*",
"min": 0,
"path": "Communication.reasonCode"
},
"isSummary": true
}, {
"path": "Communication.reasonReference",
"min": 0,
"definition": "Indicates another resource whose existence justifies this communication.",
"short": "Why was communication done?",
"mapping": [ {
"map": "Event.reasonReference",
"identity": "workflow"
}, {
"map": ".outboundRelationship[typeCode=RSON].target",
"identity": "rim"
}, {
"map": "why",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Observation"
} ],
"max": "*",
"id": "Communication.reasonReference",
"base": {
"max": "*",
"min": 0,
"path": "Communication.reasonReference"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Communication.payload",
"min": 0,
"definition": "Text, attachment(s), or resource(s) that was communicated to the recipient.",
"short": "Message payload",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "id",
"type": "value"
} ]
},
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "Communication.payload",
"base": {
"max": "*",
"min": 0,
"path": "Communication.payload"
}
}, {
"path": "Communication.payload.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Communication.payload.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Communication.payload.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Communication.payload.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Communication.payload.modifierExtension",
"min": 0,
"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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Communication.payload.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"id": "Communication.payload.content[x]",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Communication.payload.content[x]"
},
"path": "Communication.payload.content[x]",
"type": [ {
"code": "string"
}, {
"code": "Attachment"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
} ],
"short": "Message part content",
"definition": "A communicated content (or for multi-part communications, one portion of the communication)."
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Communication.payload",
"min": 0,
"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.",
"short": "Reportability Response Summary",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": true,
"sliceName": "sliceReportabilityResponseSummary",
"max": "1",
"id": "Communication.payload:sliceReportabilityResponseSummary",
"base": {
"max": "*",
"min": 0,
"path": "Communication.payload"
}
}, {
"path": "Communication.payload.id",
"min": 1,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "reportability-response-summary",
"id": "Communication.payload:sliceReportabilityResponseSummary.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Communication.payload.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Communication.payload:sliceReportabilityResponseSummary.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Communication.payload.modifierExtension",
"min": 0,
"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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Communication.payload:sliceReportabilityResponseSummary.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Communication.payload.contentString",
"min": 1,
"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.",
"short": "Reportability Response Summary text",
"type": [ {
"code": "string"
} ],
"sliceName": "contentString",
"max": "1",
"id": "Communication.payload:sliceReportabilityResponseSummary.contentString:contentString",
"example": [ {
"label": "General",
"valueString": "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."
} ],
"base": {
"max": "1",
"min": 1,
"path": "Communication.payload.content[x]"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Communication.payload",
"min": 0,
"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.",
"short": "Relevant Reportable Condition",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": true,
"sliceName": "sliceRelevantReportableCondition",
"max": "*",
"id": "Communication.payload:sliceRelevantReportableCondition",
"base": {
"max": "*",
"min": 0,
"path": "Communication.payload"
}
}, {
"path": "Communication.payload.id",
"min": 1,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "relevant-reportable-condition",
"id": "Communication.payload:sliceRelevantReportableCondition.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Communication.payload.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Communication.payload:sliceRelevantReportableCondition.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Communication.payload.modifierExtension",
"min": 0,
"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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Communication.payload:sliceRelevantReportableCondition.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Communication.payload.contentReference",
"min": 1,
"definition": "A communicated content (or for multi-part communications, one portion of the communication).",
"short": "Message part content",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/ecr/StructureDefinition/rr-relevant-reportable-condition-plandefinition"
} ],
"sliceName": "contentReference",
"max": "1",
"id": "Communication.payload:sliceRelevantReportableCondition.contentReference:contentReference",
"base": {
"max": "1",
"min": 1,
"path": "Communication.payload.content[x]"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Communication.payload",
"min": 1,
"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.\r\n\r\nThis payload is always present in the Reportability Response Communication.\r\n\r\nThe 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).\r\n",
"short": "Electronic Initial Case Report Information",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": true,
"sliceName": "sliceEICRInformation",
"max": "*",
"id": "Communication.payload:sliceEICRInformation",
"base": {
"max": "*",
"min": 0,
"path": "Communication.payload"
}
}, {
"path": "Communication.payload.id",
"min": 1,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "eicr-information",
"id": "Communication.payload:sliceEICRInformation.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Communication.payload.extension",
"min": 0,
"definition": "An Extension",
"short": "Extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Communication.payload:sliceEICRInformation.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Communication.payload.extension",
"min": 1,
"definition": "Optional Extension Element - found in all resources.",
"short": "eICR Processing Status",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-eicr-processing-status"
} ],
"mustSupport": true,
"sliceName": "eICRProcessingStatus",
"max": "1",
"id": "Communication.payload:sliceEICRInformation.extension:eICRProcessingStatus",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Communication.payload.extension.id",
"min": 1,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "eicr-processing-status",
"id": "Communication.payload:sliceEICRInformation.extension:eICRProcessingStatus.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Communication.payload.extension.extension",
"min": 0,
"definition": "An Extension",
"short": "Extension",
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Communication.payload:sliceEICRInformation.extension:eICRProcessingStatus.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Communication.payload.extension.extension",
"min": 1,
"definition": "An Extension",
"short": "Extension",
"type": [ {
"code": "Extension"
} ],
"sliceName": "eICRProcessingStatus",
"max": "1",
"id": "Communication.payload:sliceEICRInformation.extension:eICRProcessingStatus.extension:eICRProcessingStatus",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Communication.payload.extension.extension.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Communication.payload:sliceEICRInformation.extension:eICRProcessingStatus.extension:eICRProcessingStatus.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Communication.payload.extension.extension.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Communication.payload:sliceEICRInformation.extension:eICRProcessingStatus.extension:eICRProcessingStatus.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Communication.payload.extension.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "eICRProcessingStatus",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Communication.payload:sliceEICRInformation.extension:eICRProcessingStatus.extension:eICRProcessingStatus.url",
"comment": "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.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Communication.payload.extension.extension.valueReference",
"min": 0,
"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).",
"short": "Value of extension",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status"
} ],
"sliceName": "valueReference",
"max": "1",
"id": "Communication.payload:sliceEICRInformation.extension:eICRProcessingStatus.extension:eICRProcessingStatus.valueReference:valueReference",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Communication.payload.extension.extension",
"min": 0,
"definition": "Contains eICR validation output - this could be the actual output from a validator, or a link to a validation output file",
"short": "Extension",
"type": [ {
"code": "Extension"
} ],
"sliceName": "eICRValidationOutput",
"max": "*",
"id": "Communication.payload:sliceEICRInformation.extension:eICRProcessingStatus.extension:eICRValidationOutput",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Communication.payload.extension.extension.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Communication.payload:sliceEICRInformation.extension:eICRProcessingStatus.extension:eICRValidationOutput.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Communication.payload.extension.extension.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Communication.payload:sliceEICRInformation.extension:eICRProcessingStatus.extension:eICRValidationOutput.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Communication.payload.extension.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "eICRValidationOutput",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Communication.payload:sliceEICRInformation.extension:eICRProcessingStatus.extension:eICRValidationOutput.url",
"comment": "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.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Communication.payload.extension.extension.value[x]",
"min": 1,
"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).",
"short": "Value of extension",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "markdown"
}, {
"code": "string"
}, {
"code": "Attachment"
} ],
"max": "1",
"id": "Communication.payload:sliceEICRInformation.extension:eICRProcessingStatus.extension:eICRValidationOutput.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Communication.payload.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-eicr-processing-status",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Communication.payload:sliceEICRInformation.extension:eICRProcessingStatus.url",
"comment": "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.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Communication.payload.extension.value[x]",
"min": 0,
"definition": "Contains eICR validation output - this could be the actual output from a validator, or a link to a validation output file",
"short": "Value of extension",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "base64Binary"
}, {
"code": "boolean"
}, {
"code": "code"
}, {
"code": "date"
}, {
"code": "dateTime"
}, {
"code": "decimal"
}, {
"code": "id"
}, {
"code": "instant"
}, {
"code": "integer"
}, {
"code": "markdown"
}, {
"code": "oid"
}, {
"code": "positiveInt"
}, {
"code": "string"
}, {
"code": "time"
}, {
"code": "unsignedInt"
}, {
"code": "uri"
}, {
"code": "Address"
}, {
"code": "Age"
}, {
"code": "Annotation"
}, {
"code": "Attachment"
}, {
"code": "CodeableConcept"
}, {
"code": "Coding"
}, {
"code": "ContactPoint"
}, {
"code": "Count"
}, {
"code": "Distance"
}, {
"code": "Duration"
}, {
"code": "HumanName"
}, {
"code": "Identifier"
}, {
"code": "Money"
}, {
"code": "Period"
}, {
"code": "Quantity"
}, {
"code": "Range"
}, {
"code": "Ratio"
}, {
"code": "Reference"
}, {
"code": "SampledData"
}, {
"code": "Signature"
}, {
"code": "Timing"
}, {
"code": "Meta"
} ],
"max": "0",
"id": "Communication.payload:sliceEICRInformation.extension:eICRProcessingStatus.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Communication.payload.extension",
"min": 1,
"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.",
"isModifier": false,
"short": "Manually Initiated eICR",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-manually-initiated-eicr"
} ],
"mustSupport": true,
"sliceName": "manuallyInitiatedEICR",
"max": "1",
"id": "Communication.payload:sliceEICRInformation.extension:manuallyInitiatedEICR",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Communication.payload.extension.id",
"min": 1,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "manually-initiated-eicr",
"id": "Communication.payload:sliceEICRInformation.extension:manuallyInitiatedEICR.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Communication.payload.extension.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Communication.payload:sliceEICRInformation.extension:manuallyInitiatedEICR.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Communication.payload.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-manually-initiated-eicr",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Communication.payload:sliceEICRInformation.extension:manuallyInitiatedEICR.url",
"comment": "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.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Communication.payload.extension.valueBoolean",
"min": 1,
"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).",
"short": "Value of extension",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
} ],
"sliceName": "valueBoolean",
"max": "1",
"id": "Communication.payload:sliceEICRInformation.extension:manuallyInitiatedEICR.valueBoolean:valueBoolean",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Communication.payload.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-eicr-receipt-time"
} ],
"mustSupport": true,
"sliceName": "extensionEICRReceiptTime",
"max": "1",
"id": "Communication.payload:sliceEICRInformation.extension:extensionEICRReceiptTime",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Communication.payload.modifierExtension",
"min": 0,
"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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Communication.payload:sliceEICRInformation.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Communication.payload.contentReference",
"min": 1,
"definition": "A communicated content (or for multi-part communications, one portion of the communication).",
"short": "Reference to eICR Composition",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-composition"
} ],
"sliceName": "contentReference",
"max": "1",
"id": "Communication.payload:sliceEICRInformation.contentReference:contentReference",
"base": {
"max": "1",
"min": 1,
"path": "Communication.payload.content[x]"
}
}, {
"path": "Communication.payload.contentReference.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Communication.payload:sliceEICRInformation.contentReference:contentReference.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Communication.payload.contentReference.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Communication.payload:sliceEICRInformation.contentReference:contentReference.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Communication.payload.contentReference.reference",
"min": 0,
"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.",
"short": "Literal reference, Relative, internal or absolute URL",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Communication.payload:sliceEICRInformation.contentReference:contentReference.reference",
"condition": [ "ref-1" ],
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.reference"
},
"isSummary": true
}, {
"path": "Communication.payload.contentReference.identifier",
"min": 0,
"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.",
"short": "eICR Composition id",
"mapping": [ {
"map": ".identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": true,
"max": "1",
"id": "Communication.payload:sliceEICRInformation.contentReference:contentReference.identifier",
"comment": "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. \n\nWhen 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\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.identifier"
},
"isSummary": true
}, {
"path": "Communication.payload.contentReference.display",
"min": 0,
"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).",
"short": "eICR filename (or other identifying string)",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Communication.payload:sliceEICRInformation.contentReference:contentReference.display",
"comment": "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": [ {
"label": "General",
"valueString": "eicr-composition-zika.xml"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Reference.display"
},
"isSummary": true
}, {
"path": "Communication.note",
"min": 0,
"definition": "Additional notes or commentary about the communication by the sender, receiver or other interested parties.",
"short": "Comments made about the communication",
"mapping": [ {
"map": "Event.note",
"identity": "workflow"
} ],
"type": [ {
"code": "Annotation"
} ],
"max": "*",
"id": "Communication.note",
"base": {
"max": "*",
"min": 0,
"path": "Communication.note"
}
} ]
},
"status": "draft",
"id": "cc49d56c-341a-4f6b-bc11-f6a664449975",
"kind": "resource",
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/rr-communication",
"version": "0.2.0",
"differential": {
"element": [ {
"id": "Communication",
"path": "Communication",
"short": "Reportability Response Communication",
"mapping": [ {
"map": "Reportability Response Document (RR)",
"identity": "cda-rr"
} ],
"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: \n\n- Communicate the reportability status, for the responsible PHA(s)of each condition included in the electronic Initial Case Report (eICR) \n- Identify who (a PHA or an intermediary) prepared the Reportability Response \n- Indicate whether the eICR has been sent to one or more PHA(s) \n- Identify which PHA(s) has/have been sent the eICR \n- Provide contact information for the responsible PHA(s) \n- Provide suggested or required clinical follow-up activities from the responsible PHA(s), including any additional reporting needs or infection control activities \n- Provide access to clinical support resources suggested by the responsible PHA(s) for identified reportable conditions \n- Confirm eICR receipt and processing \n\nA 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. \n\nThe Reportability Response Communication is also structured to allow: \n\n- Notification, alerting, routing and queueing in work or message management systems for healthcare personnel \n- Dynamic and static URIs for supplemental data collection and the provision of information resources",
"mustSupport": true
}, {
"id": "Communication.text",
"min": 1,
"path": "Communication.text",
"constraint": [ {
"key": "nar-1",
"human": "Text narrative SHOULD conform to requirements laid out on the Narrative Guidance tab",
"severity": "error",
"expression": "not(tested)"
} ],
"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: \n\n- If the eICR was processed, then the narrative text will be populated with data from Communication.topic, Communication.payload[Reportability Response Summary], Communication.payload[Relevant Reportable Condition], and Communication.payload[Electronic Initial Case Report Information] \n\n- If the eICR was not processed and has errors, then the narrative text will only be populated with data from Communication.payload[Electronic Initial Case Report Information]",
"mustSupport": true
}, {
"id": "Communication.extension",
"path": "Communication.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "Communication.extension:reportabilityResponsePriority",
"max": "1",
"path": "Communication.extension",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-priority"
} ],
"short": "Reportability Response Priority",
"sliceName": "reportabilityResponsePriority",
"definition": "Rrepresents 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.\r\nThis “communication”-level priority should be used for EHR workflow including notification, alerting, routing and queueing.",
"mustSupport": true
}, {
"id": "Communication.identifier",
"max": "1",
"min": 1,
"path": "Communication.identifier",
"example": [ {
"label": "General",
"valueIdentifier": {
"value": "RR12346",
"system": "http://acme.org/identifiers"
}
} ],
"mapping": [ {
"map": "Reportability Response Document (RR)/id",
"identity": "cda-rr"
} ],
"mustSupport": true
}, {
"id": "Communication.category",
"max": "1",
"min": 1,
"path": "Communication.category",
"mapping": [ {
"map": "Reportability Response/code",
"identity": "cda-rr"
} ],
"isModifier": false,
"mustSupport": true,
"patternCodeableConcept": {
"coding": [ {
"code": "88085-6",
"system": "http://loinc.org",
"display": "Reportability Response Report Public Health"
} ]
}
}, {
"id": "Communication.subject",
"min": 1,
"path": "Communication.subject",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/ecr/StructureDefinition/ecr-patient"
} ],
"short": "Patient",
"example": [ {
"label": "General",
"valueReference": {
"display": "Eve Everywoman",
"reference": "Patient/ecr-patient-eve-everywoman"
}
} ],
"mustSupport": true
}, {
"id": "Communication.recipient",
"min": 1,
"path": "Communication.recipient",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/PractitionerRole"
} ],
"comment": "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": [ {
"label": "General",
"valueReference": {
"display": "Henry Seven, MD",
"reference": "PractitionerRole/ecr-practitionerrole-henry-seven"
}
} ],
"mustSupport": true
}, {
"id": "Communication.topic",
"max": "1",
"min": 1,
"path": "Communication.topic",
"short": "Reportability Response Subject",
"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.",
"mustSupport": true
}, {
"id": "Communication.topic.reference",
"max": "0",
"path": "Communication.topic.reference"
}, {
"id": "Communication.topic.identifier",
"max": "0",
"path": "Communication.topic.identifier"
}, {
"id": "Communication.topic.display",
"min": 1,
"path": "Communication.topic.display",
"short": "Reportability Response Subject text",
"example": [ {
"label": "General",
"valueString": "Public Health Reporting Communication: one or more conditions are reportable, or may be reportable to public health."
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"definition": "Contains a short high-level description of the determination of reportability.",
"mustSupport": true
}, {
"id": "Communication.context",
"path": "Communication.context",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-encounter"
} ],
"short": "eICR Encounter",
"definition": "The encounter in which the eICR was triggered.",
"mustSupport": true
}, {
"id": "Communication.sent",
"min": 1,
"path": "Communication.sent"
}, {
"id": "Communication.sender",
"min": 1,
"path": "Communication.sender",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
} ],
"short": "Author",
"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.",
"mustSupport": true
}, {
"id": "Communication.payload",
"path": "Communication.payload",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "id",
"type": "value"
} ]
}
}, {
"id": "Communication.payload:sliceReportabilityResponseSummary",
"max": "1",
"path": "Communication.payload",
"short": "Reportability Response Summary",
"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.",
"mustSupport": true
}, {
"id": "Communication.payload:sliceReportabilityResponseSummary.id",
"min": 1,
"path": "Communication.payload.id",
"fixedString": "reportability-response-summary",
"mustSupport": true
}, {
"id": "Communication.payload:sliceReportabilityResponseSummary.contentString:contentString",
"path": "Communication.payload.contentString",
"type": [ {
"code": "string"
} ],
"short": "Reportability Response Summary text",
"example": [ {
"label": "General",
"valueString": "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."
} ],
"sliceName": "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."
}, {
"id": "Communication.payload:sliceRelevantReportableCondition",
"path": "Communication.payload",
"short": "Relevant Reportable Condition",
"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.",
"mustSupport": true
}, {
"id": "Communication.payload:sliceRelevantReportableCondition.id",
"min": 1,
"path": "Communication.payload.id",
"fixedString": "relevant-reportable-condition",
"mustSupport": true
}, {
"id": "Communication.payload:sliceRelevantReportableCondition.contentReference:contentReference",
"path": "Communication.payload.contentReference",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/ecr/StructureDefinition/rr-relevant-reportable-condition-plandefinition"
} ],
"sliceName": "contentReference"
}, {
"id": "Communication.payload:sliceEICRInformation",
"min": 1,
"path": "Communication.payload",
"short": "Electronic Initial Case Report Information",
"sliceName": "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.\r\n\r\nThis payload is always present in the Reportability Response Communication.\r\n\r\nThe 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).\r\n",
"mustSupport": true
}, {
"id": "Communication.payload:sliceEICRInformation.id",
"min": 1,
"path": "Communication.payload.id",
"fixedString": "eicr-information",
"mustSupport": true
}, {
"id": "Communication.payload:sliceEICRInformation.extension",
"path": "Communication.payload.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"path": "Communication.payload.extension",
"min": 1,
"definition": "Optional Extension Element - found in all resources.",
"short": "eICR Processing Status",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-eicr-processing-status"
} ],
"mustSupport": true,
"sliceName": "eICRProcessingStatus",
"max": "1",
"id": "Communication.payload:sliceEICRInformation.extension:eICRProcessingStatus"
}, {
"id": "Communication.payload:sliceEICRInformation.extension:eICRProcessingStatus.id",
"min": 1,
"path": "Communication.payload.extension.id",
"fixedString": "eicr-processing-status",
"mustSupport": true
}, {
"id": "Communication.payload:sliceEICRInformation.extension:eICRProcessingStatus.url",
"path": "Communication.payload.extension.url",
"fixedUri": "http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-eicr-processing-status"
}, {
"path": "Communication.payload.extension",
"min": 1,
"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.",
"short": "Manually Initiated eICR",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-manually-initiated-eicr"
} ],
"mustSupport": true,
"sliceName": "manuallyInitiatedEICR",
"max": "1",
"id": "Communication.payload:sliceEICRInformation.extension:manuallyInitiatedEICR"
}, {
"id": "Communication.payload:sliceEICRInformation.extension:manuallyInitiatedEICR.id",
"min": 1,
"path": "Communication.payload.extension.id",
"fixedString": "manually-initiated-eicr",
"mustSupport": true
}, {
"id": "Communication.payload:sliceEICRInformation.extension:manuallyInitiatedEICR.url",
"path": "Communication.payload.extension.url",
"fixedUri": "http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-manually-initiated-eicr"
}, {
"id": "Communication.payload:sliceEICRInformation.extension:extensionEICRReceiptTime",
"max": "1",
"min": 0,
"path": "Communication.payload.extension",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-eicr-receipt-time"
} ],
"sliceName": "extensionEICRReceiptTime",
"mustSupport": true
}, {
"id": "Communication.payload:sliceEICRInformation.contentReference:contentReference",
"path": "Communication.payload.contentReference",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-composition"
} ],
"short": "Reference to eICR Composition",
"sliceName": "contentReference"
}, {
"id": "Communication.payload:sliceEICRInformation.contentReference:contentReference.reference",
"path": "Communication.payload.contentReference.reference",
"mustSupport": false
}, {
"id": "Communication.payload:sliceEICRInformation.contentReference:contentReference.identifier",
"path": "Communication.payload.contentReference.identifier",
"short": "eICR Composition id",
"mustSupport": true
}, {
"id": "Communication.payload:sliceEICRInformation.contentReference:contentReference.display",
"path": "Communication.payload.contentReference.display",
"short": "eICR filename (or other identifying string)",
"example": [ {
"label": "General",
"valueString": "eicr-composition-zika.xml"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"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).",
"mustSupport": true
} ]
},
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Communication"
}