{
"description": "This Communication profile represents the Reportability Response that will be created in response to an electronic Initial Case Report Composition. 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": "2020-01-29T20:30:08+00:00",
"derivation": "constraint",
"meta": {
"versionId": "57",
"lastUpdated": "2019-11-06T02:27:30.000+00:00"
},
"publisher": "HL7 Public Health Work Group",
"fhirVersion": "4.0.1",
"name": "RR_Communication",
"mapping": [ {
"name": "eCR FHIR to CDA Mapping",
"comment": "This table maps FHIR eCR profile elements to eICR/RR CDA template elements located in the CDA eICR IG (R2 STU2) and CDA RR IG (R2 STU1).",
"identity": "eCR-CDA"
}, {
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern",
"identity": "workflow"
}, {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "Communication",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": "Reportability Response Communication",
"package_version": "1.0.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": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()"
}, {
"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": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-5",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"xpath": "not(exists(f:contained/*/f:meta/f:security))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.security.empty()"
}, {
"key": "dom-6",
"human": "A resource should have narrative for robust management",
"xpath": "exists(f:text/h:div)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "warning",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
} ],
"expression": "text.`div`.exists()"
} ],
"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",
"isModifier": false,
"short": "Reportability Response Communication",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "Event",
"identity": "workflow"
}, {
"map": "[RR R1 STU1] Reportability Response Document (RR)",
"identity": "eCR-CDA"
} ],
"mustSupport": true,
"max": "*",
"id": "Communication",
"base": {
"max": "*",
"min": 0,
"path": "Communication"
},
"isSummary": false
}, {
"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.",
"isModifier": false,
"short": "Logical id of this artifact",
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Communication.meta",
"min": 0,
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"isModifier": false,
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "Communication.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Communication.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"isModifier": false,
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/languages",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "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."
},
"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"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"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]",
"isModifier": false,
"short": "Text narrative should conform to requirements laid out on the Reportability_Response_Narrative_Guidance page",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"mustSupport": true,
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "Communication.text",
"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 information is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
},
"isSummary": false
}, {
"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.",
"isModifier": false,
"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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (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": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Communication.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Communication.extension",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (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": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Communication.extension",
"min": 0,
"definition": "Represents a priority for the reportability response communication overall. It has been calculated from the highest priority of any included External Resources or the highest priority of included conditions based on a separate, jurisdictionally developed priority list.\r\nThis “communication”-level priority should be used for EHR workflow including notification, alerting, routing and queueing.",
"isModifier": false,
"short": "Reportability Response Priority",
"mapping": [ {
"map": "[RR R1 STU1] Reportability Response Priority/value",
"identity": "eCR-CDA"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension" ]
} ],
"mustSupport": true,
"sliceName": "reportabilityResponsePriority",
"max": "1",
"id": "Communication.extension:reportabilityResponsePriority",
"condition": [ "ele-1" ],
"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": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (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": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Communication.extension",
"min": 0,
"definition": "Represents either a 'transforms' or a 'replaces' structure that this Communication is related to.",
"isModifier": false,
"short": "Represents either a 'transforms' or a 'replaces' structure that this Communication is related to.",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/ecr/StructureDefinition/relates-to-extension" ]
} ],
"mustSupport": true,
"sliceName": "relatesTo",
"max": "2",
"id": "Communication.extension:relatesTo",
"condition": [ "ele-1" ],
"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": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (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": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Communication.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"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"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Communication.identifier",
"requirements": "Allows identification of the communication as it is known by various participating systems and in a way that remains consistent across servers.",
"min": 1,
"definition": "Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.",
"isModifier": false,
"short": "Unique identifier",
"mapping": [ {
"map": "Event.identifier",
"identity": "workflow"
}, {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "[RR R1 STU1] Reportability Response Document (RR)/id",
"identity": "eCR-CDA"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": true,
"max": "1",
"id": "Communication.identifier",
"comment": "This is a business identifier, not a resource identifier (see [discussion](http://hl7.org/fhir/R4/resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.",
"example": [ {
"label": "General",
"valueIdentifier": {
"value": "RR12346",
"system": "http://acme.org/identifiers"
}
} ],
"base": {
"max": "*",
"min": 0,
"path": "Communication.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Communication.instantiatesCanonical",
"min": 0,
"definition": "The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.",
"isModifier": false,
"short": "Instantiates FHIR protocol or definition",
"mapping": [ {
"map": "Event.instantiatesCanonical",
"identity": "workflow"
}, {
"map": ".outboundRelationship[typeCode=DEFN].target",
"identity": "rim"
} ],
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/PlanDefinition", "http://hl7.org/fhir/StructureDefinition/ActivityDefinition", "http://hl7.org/fhir/StructureDefinition/Measure", "http://hl7.org/fhir/StructureDefinition/OperationDefinition", "http://hl7.org/fhir/StructureDefinition/Questionnaire" ]
} ],
"max": "*",
"id": "Communication.instantiatesCanonical",
"base": {
"max": "*",
"min": 0,
"path": "Communication.instantiatesCanonical"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Communication.instantiatesUri",
"min": 0,
"definition": "The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.",
"isModifier": false,
"short": "Instantiates external protocol or definition",
"mapping": [ {
"map": "Event.instantiatesUri",
"identity": "workflow"
}, {
"map": ".outboundRelationship[typeCode=DEFN].target",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "*",
"id": "Communication.instantiatesUri",
"comment": "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.",
"base": {
"max": "*",
"min": 0,
"path": "Communication.instantiatesUri"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Communication.basedOn",
"min": 0,
"definition": "An order, proposal or plan fulfilled in whole or in part by this Communication.",
"isModifier": false,
"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, ServiceRequest, MedicationRequest, etc.",
"base": {
"max": "*",
"min": 0,
"path": "Communication.basedOn"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Communication.partOf",
"min": 0,
"definition": "Part of this action.",
"isModifier": false,
"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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Communication.inResponseTo",
"min": 0,
"definition": "Prior communication that this communication is in response to.",
"isModifier": false,
"short": "Reply to",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Communication" ]
} ],
"max": "*",
"id": "Communication.inResponseTo",
"base": {
"max": "*",
"min": 0,
"path": "Communication.inResponseTo"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Communication.status",
"min": 1,
"definition": "The status of the transmission.",
"isModifier": true,
"short": "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown",
"mapping": [ {
"map": "Event.status",
"identity": "workflow"
}, {
"map": "FiveWs.status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/event-status|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationStatus"
} ],
"description": "The status of the communication."
},
"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"
},
"isModifierReason": "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Communication.statusReason",
"min": 0,
"definition": "Captures the reason for the current state of the Communication.",
"isModifier": false,
"short": "Reason for current status",
"mapping": [ {
"map": "Event.statusReason",
"identity": "workflow"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/communication-not-done-reason",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationNotDoneReason"
} ],
"description": "Codes for the reason why a communication did not happen."
},
"alias": [ "Suspended Reason", "Cancelled Reason" ],
"max": "1",
"id": "Communication.statusReason",
"comment": "This is generally only used for \"exception\" statuses such as \"not-done\", \"suspended\" or \"aborted\". The reason for performing the event at all is captured in reasonCode, not here.",
"base": {
"max": "1",
"min": 0,
"path": "Communication.statusReason"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Communication.category",
"min": 1,
"definition": "The type of message conveyed such as alert, notification, reminder, instruction, etc.",
"isModifier": false,
"short": "Message category",
"mapping": [ {
"map": "FiveWs.class",
"identity": "w5"
}, {
"map": "[RR R1 STU1] Reportability Response/code",
"identity": "eCR-CDA"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/communication-category",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationCategory"
} ],
"description": "Codes for general categories of communications such as alerts, instructions, etc."
},
"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"
} ]
},
"base": {
"max": "*",
"min": 0,
"path": "Communication.category"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Communication.priority",
"min": 0,
"definition": "Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.",
"isModifier": false,
"short": "routine | urgent | asap | stat",
"mapping": [ {
"map": "FiveWs.grade",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"meaningWhenMissing": "If missing, this communication should be treated with normal priority",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/request-priority|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationPriority"
} ],
"description": "Codes indicating the relative importance of a communication."
},
"max": "1",
"id": "Communication.priority",
"comment": "Used to prioritize workflow (such as which communication to read first) when the communication is planned or in progress.",
"base": {
"max": "1",
"min": 0,
"path": "Communication.priority"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Communication.medium",
"min": 0,
"definition": "A channel that was used for this communication (e.g. email, fax).",
"isModifier": false,
"short": "A channel of communication",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ParticipationMode",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationMedium"
} ],
"description": "Codes for communication mediums such as phone, fax, email, in person, etc."
},
"max": "*",
"id": "Communication.medium",
"base": {
"max": "*",
"min": 0,
"path": "Communication.medium"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Communication.subject",
"min": 1,
"definition": "The patient or group that was the focus of this communication.",
"isModifier": false,
"short": "Patient",
"mapping": [ {
"map": "Event.subject",
"identity": "workflow"
}, {
"map": "FiveWs.subject[x]",
"identity": "w5"
}, {
"map": "FiveWs.subject",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/us/ecr/StructureDefinition/ecr-patient" ]
} ],
"mustSupport": true,
"alias": [ "patient" ],
"max": "1",
"id": "Communication.subject",
"base": {
"max": "1",
"min": 0,
"path": "Communication.subject"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"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.",
"isModifier": false,
"short": "Reportability Response Subject",
"mapping": [ {
"map": "FiveWs.context",
"identity": "w5"
}, {
"map": "[RR R1 STU1] Reportability Response Subject/text",
"identity": "eCR-CDA"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/communication-topic",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationTopic"
} ],
"description": "Codes describing the purpose or content of the communication."
},
"max": "1",
"id": "Communication.topic",
"comment": "Communication.topic.text can be used without any codings.",
"base": {
"max": "1",
"min": 0,
"path": "Communication.topic"
},
"isSummary": false
}, {
"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.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Communication.topic.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (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": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"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"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Communication.topic.coding",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"isModifier": false,
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"max": "*",
"id": "Communication.topic.coding",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Communication.topic.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 1,
"definition": "Contains a short high-level description of the determination of reportability.",
"isModifier": false,
"short": "Reportability Response Subject text",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Communication.topic.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"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": "CodeableConcept.text"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Communication.about",
"min": 0,
"definition": "Other resources that pertain to this communication and to which this communication should be associated.",
"isModifier": false,
"short": "Resources that pertain to this communication",
"mapping": [ {
"map": "FiveWs.context",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"max": "*",
"id": "Communication.about",
"comment": "Don't use Communication.about element when a more specific element exists, such as basedOn or reasonReference.",
"base": {
"max": "*",
"min": 0,
"path": "Communication.about"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Communication.encounter",
"min": 0,
"definition": "The encounter in which the eICR was triggered.",
"isModifier": false,
"short": "eICR Encounter",
"mapping": [ {
"map": "Event.context",
"identity": "workflow"
}, {
"map": "FiveWs.context",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-encounter" ]
} ],
"mustSupport": true,
"max": "1",
"id": "Communication.encounter",
"comment": "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.",
"base": {
"max": "1",
"min": 0,
"path": "Communication.encounter"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Communication.sent",
"min": 1,
"definition": "The time when this communication was sent.",
"isModifier": false,
"short": "When sent",
"mapping": [ {
"map": "Event.occurrence[x] {Invariant: maps to period.start}",
"identity": "workflow"
}, {
"map": "FiveWs.done[x]",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "Communication.sent",
"base": {
"max": "1",
"min": 0,
"path": "Communication.sent"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Communication.received",
"min": 0,
"definition": "The time when this communication arrived at the destination.",
"isModifier": false,
"short": "When received",
"mapping": [ {
"map": "Event.occurrence[x] {Invariant: maps to period.end}",
"identity": "workflow"
}, {
"map": "FiveWs.done[x]",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "Communication.received",
"base": {
"max": "1",
"min": 0,
"path": "Communication.received"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Communication.recipient",
"min": 1,
"definition": "Reporting may be identified for multiple PHAs by the PHA system (or its intermediary) (because the patient's residence and the provider location are in separate jurisdictions) including other identified organization (such as an HIE) to which the eICR (if deemed reportable) and/or the Reportability Response will be routed.",
"isModifier": false,
"short": "Reportability Response recipients",
"mapping": [ {
"map": "Event.performer.actor",
"identity": "workflow"
}, {
"map": "FiveWs.actor",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/us/ecr/StructureDefinition/ecr-organization", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner", "http://hl7.org/fhir/us/ecr/StructureDefinition/ecr-practitionerrole" ]
} ],
"mustSupport": true,
"max": "*",
"id": "Communication.recipient",
"base": {
"max": "*",
"min": 0,
"path": "Communication.recipient"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"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.",
"isModifier": false,
"short": "Author",
"mapping": [ {
"map": "Event.performer.actor",
"identity": "workflow"
}, {
"map": "FiveWs.actor",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/us/ecr/StructureDefinition/ecr-organization", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner", "http://hl7.org/fhir/us/ecr/StructureDefinition/ecr-practitionerrole" ]
} ],
"mustSupport": true,
"max": "1",
"id": "Communication.sender",
"base": {
"max": "1",
"min": 0,
"path": "Communication.sender"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Communication.reasonCode",
"min": 0,
"definition": "The reason or justification for the communication.",
"isModifier": false,
"short": "Indication for message",
"mapping": [ {
"map": "Event.reasonCode",
"identity": "workflow"
}, {
"map": "FiveWs.why[x]",
"identity": "w5"
}, {
"map": ".reasonCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/clinical-findings",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationReason"
} ],
"description": "Codes for describing reasons for the occurrence of a communication."
},
"max": "*",
"id": "Communication.reasonCode",
"comment": "Textual reasons can be captured using reasonCode.text.",
"base": {
"max": "*",
"min": 0,
"path": "Communication.reasonCode"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Communication.reasonReference",
"min": 0,
"definition": "Indicates another resource whose existence justifies this communication.",
"isModifier": false,
"short": "Why was communication done?",
"mapping": [ {
"map": "Event.reasonReference",
"identity": "workflow"
}, {
"map": "FiveWs.why[x]",
"identity": "w5"
}, {
"map": ".outboundRelationship[typeCode=RSON].target",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Condition", "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/DiagnosticReport", "http://hl7.org/fhir/StructureDefinition/DocumentReference" ]
} ],
"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": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Communication.payload",
"min": 0,
"definition": "Text, attachment(s), or resource(s) that was communicated to the recipient.",
"isModifier": false,
"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"
},
"isSummary": false
}, {
"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.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Communication.payload.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (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": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"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"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (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": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Communication.payload.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"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"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Communication.payload.content[x]",
"min": 1,
"definition": "A communicated content (or for multi-part communications, one portion of the communication).",
"isModifier": false,
"short": "Message part content",
"type": [ {
"code": "string"
}, {
"code": "Attachment"
}, {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"max": "1",
"id": "Communication.payload.content[x]",
"base": {
"max": "1",
"min": 1,
"path": "Communication.payload.content[x]"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (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.",
"isModifier": false,
"short": "Reportability Response Summary",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": true,
"sliceName": "sliceReportabilityResponseSummary",
"max": "1",
"id": "Communication.payload:sliceReportabilityResponseSummary",
"base": {
"max": "*",
"min": 0,
"path": "Communication.payload"
},
"isSummary": false
}, {
"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.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"mustSupport": true,
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "reportability-response-summary",
"id": "Communication.payload:sliceReportabilityResponseSummary.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (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": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"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"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (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": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Communication.payload.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"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"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Communication.payload.content[x]",
"min": 1,
"definition": "A communicated content (or for multi-part communications, one portion of the communication).",
"isModifier": false,
"short": "Reportability Response Summary text",
"mapping": [ {
"map": "[RR R1 STU1] Reportability Response Summary/text",
"identity": "eCR-CDA"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "Communication.payload:sliceReportabilityResponseSummary.content[x]",
"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]"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Communication.payload",
"min": 1,
"definition": "This payload slice contains information about the eICR Document to which this Communication is a response. The date/time of receipt and a document reference are represented in the Electronic Initial Case Report Composition Profile (contained in the eICR Document Bundle) and the processing status of the eICR Document is contained in the eICR Processing Status profile. If the eICR Document was manually or alternately initiated by a healthcare provider, this is indicated by the presence of the Initiation Type eICR extension.\n\nThis payload slice is always present in the Reportability Response Communication.\n\nThe text element (narrative block) in this section is only populated and displayed when the eICR Document was not processed (eICR Processing Status/code=\"RRVS22\", \"eICR was not processed - error\") and that text element contains the eICR processing status reason(s).\n",
"isModifier": false,
"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"
},
"isSummary": false
}, {
"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.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"mustSupport": true,
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "eicr-information",
"id": "Communication.payload:sliceEICRInformation.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (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": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Communication.payload.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"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"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (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": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Communication.payload.extension",
"min": 1,
"definition": "This extension constains processing status information about the eICR.",
"isModifier": false,
"short": "eICR Processing Status",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-extension" ]
} ],
"mustSupport": true,
"sliceName": "extensionEICRProcessingStatus",
"max": "1",
"id": "Communication.payload:sliceEICRInformation.extension:extensionEICRProcessingStatus",
"condition": [ "ele-1" ],
"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": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (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": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Communication.payload.extension",
"min": 0,
"definition": "The presence of this extension indicates whether or not the eICR CDA document for which this Reportability Response is a response, was either alternately or manually initiated. The eICR could also contain RCTC trigger codes (automatic trigger code initiation).",
"isModifier": false,
"short": "Alternately or Manually Initiated eICR",
"mapping": [ {
"map": "[RR R1 STU1] Manually Initiated eICR/code",
"comment": "No mapping for Alternately Initiation eICR in the current version of CDA RR",
"identity": "eCR-CDA"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-initiation-type-extension" ]
} ],
"mustSupport": true,
"sliceName": "extensionAlternatelyManuallyInitiatedEICR",
"max": "1",
"id": "Communication.payload:sliceEICRInformation.extension:extensionAlternatelyManuallyInitiatedEICR",
"condition": [ "ele-1" ],
"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": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (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": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Communication.payload.extension",
"min": 0,
"definition": "This extension contains the date and time of eICR receipt.",
"isModifier": false,
"short": "Date and time of eICR receipt",
"mapping": [ {
"map": "[RR R1 STU1] Received eICR Information/eICR External Document Reference/effectiveTime",
"identity": "eCR-CDA"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-receipt-time-extension" ]
} ],
"mustSupport": true,
"sliceName": "extensionEICRReceiptTime",
"max": "1",
"id": "Communication.payload:sliceEICRInformation.extension:extensionEICRReceiptTime",
"condition": [ "ele-1" ],
"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": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (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": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Communication.payload.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"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"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Communication.payload.content[x]",
"min": 1,
"definition": "Reference to eICR Document Bundle or eICR CDA document. If Reference: 1. Use id for eICR Document Bundle id 2. Use display for eICR file name (or other identifying string): recommended primarily for dealing with eICR error cases. In the case where an eICR document is unreadable for some reason, it is possible that the only identifying information is the eICR filename (or other identifying string). If Attachment: 1. Use url for eICR Document id. 2. Use title for eICR file name (or other identifying string).",
"isModifier": false,
"short": "Reference to eICR Document Bundle or eICR CDA document",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle" ]
}, {
"code": "Attachment"
} ],
"mustSupport": true,
"max": "1",
"id": "Communication.payload:sliceEICRInformation.content[x]",
"base": {
"max": "1",
"min": 1,
"path": "Communication.payload.content[x]"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (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.",
"isModifier": false,
"short": "Relevant Reportable Condition",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": true,
"sliceName": "sliceRelevantReportableCondition",
"max": "*",
"id": "Communication.payload:sliceRelevantReportableCondition",
"base": {
"max": "*",
"min": 0,
"path": "Communication.payload"
},
"isSummary": false
}, {
"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.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"mustSupport": true,
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "relevant-reportable-condition",
"id": "Communication.payload:sliceRelevantReportableCondition.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (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": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"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"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (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": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Communication.payload.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"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"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Communication.payload.content[x]",
"min": 1,
"definition": "A communicated content (or for multi-part communications, one portion of the communication).",
"isModifier": false,
"short": "Reference to Relevant Reportable Condition PlanDefinition",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/us/ecr/StructureDefinition/rr-relevant-reportable-condition-plandefinition" ]
} ],
"mustSupport": true,
"max": "1",
"id": "Communication.payload:sliceRelevantReportableCondition.content[x]",
"base": {
"max": "1",
"min": 1,
"path": "Communication.payload.content[x]"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Communication.note",
"min": 0,
"definition": "Additional notes or commentary about the communication by the sender, receiver or other interested parties.",
"isModifier": false,
"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"
},
"isSummary": false
} ]
},
"status": "active",
"id": "9ee1a650-43a9-4635-8c46-0a759f54e78f",
"kind": "resource",
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/rr-communication",
"version": "1.0.0",
"differential": {
"element": [ {
"id": "Communication",
"path": "Communication",
"short": "Reportability Response Communication",
"mapping": [ {
"map": "[RR R1 STU1] Reportability Response Document (RR)",
"identity": "eCR-CDA"
} ],
"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",
"short": "Text narrative should conform to requirements laid out on the Reportability_Response_Narrative_Guidance page",
"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"
} ]
}
}, {
"path": "Communication.extension",
"definition": "Represents a priority for the reportability response communication overall. It has been calculated from the highest priority of any included External Resources or the highest priority of included conditions based on a separate, jurisdictionally developed priority list.\r\nThis “communication”-level priority should be used for EHR workflow including notification, alerting, routing and queueing.",
"short": "Reportability Response Priority",
"mapping": [ {
"map": "[RR R1 STU1] Reportability Response Priority/value",
"identity": "eCR-CDA"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension" ]
} ],
"mustSupport": true,
"sliceName": "reportabilityResponsePriority",
"max": "1",
"id": "Communication.extension:reportabilityResponsePriority"
}, {
"id": "Communication.extension:relatesTo",
"max": "2",
"path": "Communication.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/ecr/StructureDefinition/relates-to-extension" ]
} ],
"short": "Represents either a 'transforms' or a 'replaces' structure that this Communication is related to.",
"sliceName": "relatesTo",
"definition": "Represents either a 'transforms' or a 'replaces' structure that this Communication is related to.",
"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": "[RR R1 STU1] Reportability Response Document (RR)/id",
"identity": "eCR-CDA"
} ],
"mustSupport": true
}, {
"id": "Communication.category",
"max": "1",
"min": 1,
"path": "Communication.category",
"mapping": [ {
"map": "[RR R1 STU1] Reportability Response/code",
"identity": "eCR-CDA"
} ],
"isModifier": false,
"mustSupport": true,
"patternCodeableConcept": {
"coding": [ {
"code": "88085-6",
"system": "http://loinc.org"
} ]
}
}, {
"id": "Communication.subject",
"min": 1,
"path": "Communication.subject",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/us/ecr/StructureDefinition/ecr-patient" ]
} ],
"short": "Patient",
"mustSupport": true
}, {
"id": "Communication.topic",
"max": "1",
"min": 1,
"path": "Communication.topic",
"short": "Reportability Response Subject",
"mapping": [ {
"map": "[RR R1 STU1] Reportability Response Subject/text",
"identity": "eCR-CDA"
} ],
"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.text",
"min": 1,
"path": "Communication.topic.text",
"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."
} ],
"definition": "Contains a short high-level description of the determination of reportability.",
"mustSupport": true
}, {
"id": "Communication.encounter",
"path": "Communication.encounter",
"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.recipient",
"min": 1,
"path": "Communication.recipient",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/us/ecr/StructureDefinition/ecr-organization", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner", "http://hl7.org/fhir/us/ecr/StructureDefinition/ecr-practitionerrole" ]
} ],
"short": "Reportability Response recipients",
"definition": "Reporting may be identified for multiple PHAs by the PHA system (or its intermediary) (because the patient's residence and the provider location are in separate jurisdictions) including other identified organization (such as an HIE) to which the eICR (if deemed reportable) and/or the Reportability Response will be routed.",
"mustSupport": true
}, {
"id": "Communication.sender",
"min": 1,
"path": "Communication.sender",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/us/ecr/StructureDefinition/ecr-organization", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner", "http://hl7.org/fhir/us/ecr/StructureDefinition/ecr-practitionerrole" ]
} ],
"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.content[x]",
"path": "Communication.payload.content[x]",
"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."
} ],
"mapping": [ {
"map": "[RR R1 STU1] Reportability Response Summary/text",
"identity": "eCR-CDA"
} ],
"mustSupport": true
}, {
"id": "Communication.payload:sliceEICRInformation",
"min": 1,
"path": "Communication.payload",
"short": "Electronic Initial Case Report Information",
"sliceName": "sliceEICRInformation",
"definition": "This payload slice contains information about the eICR Document to which this Communication is a response. The date/time of receipt and a document reference are represented in the Electronic Initial Case Report Composition Profile (contained in the eICR Document Bundle) and the processing status of the eICR Document is contained in the eICR Processing Status profile. If the eICR Document was manually or alternately initiated by a healthcare provider, this is indicated by the presence of the Initiation Type eICR extension.\n\nThis payload slice is always present in the Reportability Response Communication.\n\nThe text element (narrative block) in this section is only populated and displayed when the eICR Document was not processed (eICR Processing Status/code=\"RRVS22\", \"eICR was not processed - error\") and that text element contains the eICR processing status reason(s).\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": "This extension constains processing status information about the eICR.",
"short": "eICR Processing Status",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-extension" ]
} ],
"mustSupport": true,
"sliceName": "extensionEICRProcessingStatus",
"max": "1",
"id": "Communication.payload:sliceEICRInformation.extension:extensionEICRProcessingStatus"
}, {
"path": "Communication.payload.extension",
"min": 0,
"definition": "The presence of this extension indicates whether or not the eICR CDA document for which this Reportability Response is a response, was either alternately or manually initiated. The eICR could also contain RCTC trigger codes (automatic trigger code initiation).",
"short": "Alternately or Manually Initiated eICR",
"mapping": [ {
"map": "[RR R1 STU1] Manually Initiated eICR/code",
"comment": "No mapping for Alternately Initiation eICR in the current version of CDA RR",
"identity": "eCR-CDA"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-initiation-type-extension" ]
} ],
"mustSupport": true,
"sliceName": "extensionAlternatelyManuallyInitiatedEICR",
"max": "1",
"id": "Communication.payload:sliceEICRInformation.extension:extensionAlternatelyManuallyInitiatedEICR"
}, {
"path": "Communication.payload.extension",
"min": 0,
"definition": "This extension contains the date and time of eICR receipt.",
"short": "Date and time of eICR receipt",
"mapping": [ {
"map": "[RR R1 STU1] Received eICR Information/eICR External Document Reference/effectiveTime",
"identity": "eCR-CDA"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-receipt-time-extension" ]
} ],
"mustSupport": true,
"sliceName": "extensionEICRReceiptTime",
"max": "1",
"id": "Communication.payload:sliceEICRInformation.extension:extensionEICRReceiptTime"
}, {
"id": "Communication.payload:sliceEICRInformation.content[x]",
"path": "Communication.payload.content[x]",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle" ]
}, {
"code": "Attachment"
} ],
"short": "Reference to eICR Document Bundle or eICR CDA document",
"definition": "Reference to eICR Document Bundle or eICR CDA document. If Reference: 1. Use id for eICR Document Bundle id 2. Use display for eICR file name (or other identifying string): recommended primarily for dealing with eICR error cases. In the case where an eICR document is unreadable for some reason, it is possible that the only identifying information is the eICR filename (or other identifying string). If Attachment: 1. Use url for eICR Document id. 2. Use title for eICR file name (or other identifying string).",
"mustSupport": true
}, {
"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.content[x]",
"path": "Communication.payload.content[x]",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/us/ecr/StructureDefinition/rr-relevant-reportable-condition-plandefinition" ]
} ],
"short": "Reference to Relevant Reportable Condition PlanDefinition",
"mustSupport": true
} ]
},
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Communication"
}