{ "resourceType": "StructureDefinition", "id": "Profile-Communication-External", "url": "https://health.gov.on.ca/idms/fhir/StructureDefinition/Communication-External", "version": "1.0.0", "name": "ClientCommunication", "title": "Communication External", "status": "active", "description": "Communications between the IDMS system and the External Companies.", "fhirVersion": "4.0.1", "mapping": [ { "identity": "workflow", "uri": "http://hl7.org/fhir/workflow", "name": "Workflow Pattern" }, { "identity": "w5", "uri": "http://hl7.org/fhir/fivews", "name": "FiveWs Pattern Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "resource", "abstract": false, "type": "Communication", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Communication", "derivation": "constraint", "snapshot": { "element": [ { "id": "Communication", "path": "Communication", "short": "A clinical or business level record of information being transmitted or shared", "definition": "#### **_`IDMS: This is used to record data exchanges between IDMS and Client Systems. This includes sending submission data and the client sending status updates and files`_**\n\n\nAn occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition.", "min": 0, "max": "*", "base": { "path": "Communication", "min": 0, "max": "*" }, "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-3", "severity": "error", "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", "expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "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." } ], "key": "dom-6", "severity": "warning", "human": "A resource should have narrative for robust management", "expression": "text.`div`.exists()", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-5", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "expression": "contained.meta.security.empty()", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" } ], "mustSupport": false, "isModifier": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "Entity, Role, or Act" }, { "identity": "workflow", "map": "Event" }, { "identity": "w5", "map": "workflow.encounter" } ] }, { "id": "Communication.id", "path": "Communication.id", "short": "Logical id of this artifact", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "comment": "Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.", "min": 0, "max": "1", "base": { "path": "Resource.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "id" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "mustSupport": false, "isModifier": false, "isSummary": true }, { "id": "Communication.meta", "path": "Communication.meta", "short": "Metadata about the resource", "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.", "min": 0, "max": "1", "base": { "path": "Resource.meta", "min": 0, "max": "1" }, "type": [ { "code": "Meta" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Communication.implicitRules", "path": "Communication.implicitRules", "short": "A set of rules under which this content was created", "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.", "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 its narrative along with other profiles, value sets, etc.", "min": 0, "max": "1", "base": { "path": "Resource.implicitRules", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": true, "isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation", "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Communication.language", "path": "Communication.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "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).", "min": 0, "max": "1", "base": { "path": "Resource.language", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" } ], "strength": "required", "description": "IETF language tag for a human language", "valueSet": "http://hl7.org/fhir/ValueSet/all-languages|5.0.0", "additional": [ { "purpose": "starter", "valueSet": "http://hl7.org/fhir/ValueSet/languages" } ] }, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Communication.text", "path": "Communication.text", "short": "Text summary of the resource, for human interpretation", "definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", "comment": "Contained resources do not have a 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.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "base": { "path": "DomainResource.text", "min": 0, "max": "1" }, "type": [ { "code": "Narrative" } ], "condition": [ "dom-6" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" }, { "identity": "rim", "map": "Act.text?" } ] }, { "id": "Communication.contained", "path": "Communication.contained", "short": "Contained, inline Resources", "definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.", "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.", "alias": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "*", "base": { "path": "DomainResource.contained", "min": 0, "max": "*" }, "type": [ { "code": "Resource" } ], "condition": [ "dom-2", "dom-4", "dom-3", "dom-5" ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Communication.extension", "path": "Communication.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, 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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Communication.extension:externalIndicator", "path": "Communication.extension", "sliceName": "externalIndicator", "short": "Optional Extensions Element", "definition": "#### **_`IDMS: Indicates this is was created by external user.`_**", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "1", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "https://health.gov.on.ca/idms/fhir/StructureDefinition/Extension-External-Indicator" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Communication.modifierExtension", "path": "Communication.modifierExtension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Extensions that cannot be ignored", "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 managable, 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).", "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.", "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](extensibility.html#modifierExtension).", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mustSupport": false, "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Communication.identifier", "path": "Communication.identifier", "short": "Unique identifier", "definition": "Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.", "comment": "This is a business identifier, not a resource identifier (see [discussion](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.", "requirements": "Allows identification of the communication as it is known by various participating systems and in a way that remains consistent across servers.", "min": 0, "max": "0", "base": { "path": "Communication.identifier", "min": 0, "max": "*" }, "type": [ { "code": "Identifier" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ident-1", "severity": "warning", "human": "Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason", "expression": "value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Identifier" } ], "mustSupport": false, "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)" }, { "identity": "rim", "map": "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]" }, { "identity": "servd", "map": "Identifier" }, { "identity": "workflow", "map": "Event.identifier" }, { "identity": "w5", "map": "FiveWs.identifier" } ] }, { "id": "Communication.instantiatesCanonical", "path": "Communication.instantiatesCanonical", "short": "Instantiates FHIR protocol or definition", "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.", "comment": "see [Canonical References](references.html#canonical)", "min": 0, "max": "0", "base": { "path": "Communication.instantiatesCanonical", "min": 0, "max": "*" }, "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" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "Event.instantiatesCanonical" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target" } ] }, { "id": "Communication.instantiatesUri", "path": "Communication.instantiatesUri", "short": "Instantiates external protocol or definition", "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.", "comment": "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.", "min": 0, "max": "0", "base": { "path": "Communication.instantiatesUri", "min": 0, "max": "*" }, "type": [ { "code": "uri" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "Event.instantiatesUri" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target" } ] }, { "id": "Communication.basedOn", "path": "Communication.basedOn", "short": "Request fulfilled by this communication", "definition": "#### **_`IDMS: This is a reference to the Request.`_**\n\nAn order, proposal or plan fulfilled in whole or in part by this Communication.", "comment": "This must point to some sort of a 'Request' resource, such as CarePlan, CommunicationRequest, ServiceRequest, MedicationRequest, etc.", "alias": [ "fulfills" ], "min": 1, "max": "1", "base": { "path": "Communication.basedOn", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": [ "https://health.gov.on.ca/idms/fhir/StructureDefinition/IDMS-ServiceRequest-New" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))", "source": "http://hl7.org/fhir/StructureDefinition/Reference" }, { "key": "ref-2", "severity": "error", "human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).", "expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mustSupport": false, "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "workflow", "map": "Event.basedOn" } ] }, { "id": "Communication.partOf", "path": "Communication.partOf", "short": "Part of referenced event (e.g. Communication, Procedure)", "definition": "#### **_`IDMS: If this is an Additional Information Submission communication this is a reference to that Child Request.`_**", "comment": "The event the communication was part of - e.g. if you disclosed as \"part\" of counselling, it would be partOf that Procedure.", "alias": [ "container" ], "min": 0, "max": "1", "base": { "path": "Communication.partOf", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": [ "https://health.gov.on.ca/idms/fhir/StructureDefinition/IDMS-ServiceRequest-Child-Submission" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))", "source": "http://hl7.org/fhir/StructureDefinition/Reference" }, { "key": "ref-2", "severity": "error", "human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).", "expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mustSupport": false, "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "workflow", "map": "Event.partOf" } ] }, { "id": "Communication.inResponseTo", "path": "Communication.inResponseTo", "short": "Reply to", "definition": "Prior communication that this communication is in response to.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "min": 0, "max": "0", "base": { "path": "Communication.inResponseTo", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Communication" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))", "source": "http://hl7.org/fhir/StructureDefinition/Reference" }, { "key": "ref-2", "severity": "error", "human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).", "expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" } ] }, { "id": "Communication.status", "path": "Communication.status", "short": "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown", "definition": "#### **_`IDMS: Use 'completed' if it was sucessful and 'entered-in-error' for errors.`_**\n\nThe status of the transmission.", "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.", "min": 1, "max": "1", "base": { "path": "Communication.status", "min": 1, "max": "1" }, "type": [ { "code": "code" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": true, "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, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CommunicationStatus" } ], "strength": "required", "description": "The status of the communication.", "valueSet": "http://hl7.org/fhir/ValueSet/event-status|5.0.0" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "Event.status" }, { "identity": "w5", "map": "FiveWs.status" } ] }, { "id": "Communication.statusReason", "path": "Communication.statusReason", "short": "Reason for current status", "definition": "#### **_`IDMS: This is the code for the IDMS error message.`_**\n\nThe status of the transmission.", "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.", "alias": [ "Suspended Reason", "Cancelled Reason" ], "min": 0, "max": "0", "base": { "path": "Communication.statusReason", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CommunicationNotDoneReason" } ], "strength": "required", "description": "Codes for the reason why a communication did not happen.", "valueSet": "http://health.gov.on.ca/sadie/fhir/ValueSet/FlexForms-ClientCommunication-Errors" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "workflow", "map": "Event.statusReason" } ] }, { "id": "Communication.category", "path": "Communication.category", "short": "Message category", "definition": "#### **_`SUBMISSION`_**\n #### **_`code:COMMUNICATION-TYPE-SUBMISSION ; system:https://health.gov.on.ca/idms/fhir/CodeSystem/IDMS-Internal ; display:Request Submitted `_**\n\n #### **_`ADDITIONAL INFORMATION`_**\n #### **_`code: COMMUNICATION-TYPE-ADDITIONAL-INFO; system:https://health.gov.on.ca/idms/fhir/CodeSystem/IDMS-Internal ; display:Additional Information Submitted `_**", "comment": "There may be multiple axes of categorization and one communication may serve multiple purposes.", "min": 0, "max": "1", "base": { "path": "Communication.category", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CommunicationCategory" } ], "strength": "required", "description": "Codes for general categories of communications such as alerts, instructions, etc.", "valueSet": "http://health.gov.on.ca/sadie/fhir/ValueSet/FlexForms-CommunicationTypes" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "w5", "map": "FiveWs.class" } ] }, { "id": "Communication.priority", "path": "Communication.priority", "short": "routine | urgent | asap | stat", "definition": "Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.", "comment": "Used to prioritize workflow (such as which communication to read first) when the communication is planned or in progress.", "min": 0, "max": "0", "base": { "path": "Communication.priority", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "meaningWhenMissing": "If missing, this communication should be treated with normal priority", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CommunicationPriority" } ], "strength": "required", "description": "Codes indicating the relative importance of a communication.", "valueSet": "http://hl7.org/fhir/ValueSet/request-priority|5.0.0" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "w5", "map": "FiveWs.grade" } ] }, { "id": "Communication.medium", "path": "Communication.medium", "short": "A channel of communication", "definition": "A channel that was used for this communication (e.g. email, fax).", "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.", "min": 0, "max": "0", "base": { "path": "Communication.medium", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CommunicationMedium" } ], "strength": "example", "description": "Codes for communication mediums such as phone, fax, email, in person, etc.", "valueSet": "http://terminology.hl7.org/ValueSet/v3-ParticipationMode" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" } ] }, { "id": "Communication.subject", "path": "Communication.subject", "short": "Focus of message", "definition": "The patient or group that was the focus of this communication.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "alias": [ "patient" ], "min": 0, "max": "0", "base": { "path": "Communication.subject", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Group" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))", "source": "http://hl7.org/fhir/StructureDefinition/Reference" }, { "key": "ref-2", "severity": "error", "human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).", "expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mustSupport": false, "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "workflow", "map": "Event.subject" }, { "identity": "w5", "map": "FiveWs.subject[x]" } ] }, { "id": "Communication.subject.id", "path": "Communication.subject.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "condition": [ "ele-1" ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Communication.subject.extension", "path": "Communication.subject.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "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 managable, 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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Communication.subject.reference", "path": "Communication.subject.reference", "short": "Literal reference, Relative, internal or absolute URL", "definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.", "comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.", "min": 0, "max": "0", "base": { "path": "Reference.reference", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ref-2", "ref-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Communication.subject.type", "path": "Communication.subject.type", "short": "Type the reference refers to (e.g. \"Patient\") - must be a resource in resources", "definition": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).", "comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.", "min": 0, "max": "0", "base": { "path": "Reference.type", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "Aa resource (or, for logical models, the URI of the logical model)." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "FHIRResourceTypeExt" } ], "strength": "extensible", "description": "Aa resource (or, for logical models, the URI of the logical model).", "valueSet": "http://hl7.org/fhir/ValueSet/resource-types" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Communication.subject.identifier", "path": "Communication.subject.identifier", "short": "Logical reference, when literal reference is not known", "definition": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.", "comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).\n\nThis element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.", "min": 0, "max": "0", "base": { "path": "Reference.identifier", "min": 0, "max": "1" }, "type": [ { "code": "Identifier" } ], "condition": [ "ref-2" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ident-1", "severity": "warning", "human": "Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason", "expression": "value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Identifier" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)" }, { "identity": "rim", "map": "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]" }, { "identity": "servd", "map": "Identifier" }, { "identity": "rim", "map": ".identifier" } ] }, { "id": "Communication.subject.display", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Communication.subject.display", "short": "Text alternative for the resource", "definition": "Plain text narrative that identifies the resource in addition to the resource reference.", "comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.", "min": 0, "max": "0", "base": { "path": "Reference.display", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ref-2" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Communication.topic", "path": "Communication.topic", "short": "Description of the purpose/content", "definition": "Description of the purpose/content, similar to a subject line in an email.", "comment": "Communication.topic.text can be used without any codings.", "min": 0, "max": "0", "base": { "path": "Communication.topic", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CommunicationTopic" } ], "strength": "example", "description": "Codes describing the purpose or content of the communication.", "valueSet": "http://hl7.org/fhir/ValueSet/communication-topic" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "w5", "map": "FiveWs.context" } ] }, { "id": "Communication.about", "path": "Communication.about", "short": "Resources that pertain to this communication", "definition": "Other resources that pertain to this communication and to which this communication should be associated.", "comment": "Don't use Communication.about element when a more specific element exists, such as basedOn or reasonReference.", "min": 0, "max": "0", "base": { "path": "Communication.about", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))", "source": "http://hl7.org/fhir/StructureDefinition/Reference" }, { "key": "ref-2", "severity": "error", "human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).", "expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "w5", "map": "FiveWs.context" } ] }, { "id": "Communication.about.id", "path": "Communication.about.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "condition": [ "ele-1" ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Communication.about.extension", "path": "Communication.about.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "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 managable, 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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Communication.about.reference", "path": "Communication.about.reference", "short": "Literal reference, Relative, internal or absolute URL", "definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.", "comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.", "min": 0, "max": "0", "base": { "path": "Reference.reference", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ref-2", "ref-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Communication.about.type", "path": "Communication.about.type", "short": "Type the reference refers to (e.g. \"Patient\") - must be a resource in resources", "definition": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).", "comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.", "min": 0, "max": "0", "base": { "path": "Reference.type", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "Aa resource (or, for logical models, the URI of the logical model)." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "FHIRResourceTypeExt" } ], "strength": "extensible", "description": "Aa resource (or, for logical models, the URI of the logical model).", "valueSet": "http://hl7.org/fhir/ValueSet/resource-types" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Communication.about.identifier", "path": "Communication.about.identifier", "short": "Logical reference, when literal reference is not known", "definition": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.", "comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).\n\nThis element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.", "min": 0, "max": "0", "base": { "path": "Reference.identifier", "min": 0, "max": "1" }, "type": [ { "code": "Identifier" } ], "condition": [ "ref-2" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ident-1", "severity": "warning", "human": "Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason", "expression": "value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Identifier" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)" }, { "identity": "rim", "map": "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]" }, { "identity": "servd", "map": "Identifier" }, { "identity": "rim", "map": ".identifier" } ] }, { "id": "Communication.about.display", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Communication.about.display", "short": "Text alternative for the resource", "definition": "Plain text narrative that identifies the resource in addition to the resource reference.", "comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.", "min": 0, "max": "0", "base": { "path": "Reference.display", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ref-2" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Communication.encounter", "path": "Communication.encounter", "short": "The Encounter during which this Communication was created", "definition": "The Encounter during which this Communication was created or to which the creation of this record is tightly associated.", "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.", "min": 0, "max": "0", "base": { "path": "Communication.encounter", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Encounter" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))", "source": "http://hl7.org/fhir/StructureDefinition/Reference" }, { "key": "ref-2", "severity": "error", "human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).", "expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mustSupport": false, "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "workflow", "map": "Event.encounter" }, { "identity": "w5", "map": "FiveWs.context" } ] }, { "id": "Communication.sent", "path": "Communication.sent", "short": "When sent", "definition": "#### **_`IDMS: If DIRECT is doing the sending then this is populated otherwise it is null`_**\n\nThe time when this communication was sent.", "comment": "UTC offset is allowed for dates and partial dates", "min": 0, "max": "1", "base": { "path": "Communication.sent", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "Event.occurrence[x] {Invariant: maps to period.start}" }, { "identity": "w5", "map": "FiveWs.done[x]" } ] }, { "id": "Communication.received", "path": "Communication.received", "short": "When received", "definition": "#### **_`IDMS: If DIRECT is doing the receiving then this is populated otherwise it is null`_**\n\nThe time when this communication arrived at the destination.", "comment": "UTC offset is allowed for dates and partial dates", "min": 0, "max": "1", "base": { "path": "Communication.received", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "Event.occurrence[x] {Invariant: maps to period.end}" }, { "identity": "w5", "map": "FiveWs.done[x]" } ] }, { "id": "Communication.recipient", "path": "Communication.recipient", "short": "Who the information is shared with", "definition": "#### **_`IDMS: If DIRECT is doing the sending then the reference will be populated with a reference to the Organization and display will be populated with the Organization Name. If DIRECT is receiving then the reference is null and the display = DIRECT`_**\n\n\n.", "comment": "If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).", "min": 1, "max": "1", "base": { "path": "Communication.recipient", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))", "source": "http://hl7.org/fhir/StructureDefinition/Reference" }, { "key": "ref-2", "severity": "error", "human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).", "expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "workflow", "map": "Event.performer.actor" }, { "identity": "w5", "map": "FiveWs.actor" } ] }, { "id": "Communication.recipient.id", "path": "Communication.recipient.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "condition": [ "ele-1" ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Communication.recipient.extension", "path": "Communication.recipient.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "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 managable, 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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Communication.recipient.reference", "path": "Communication.recipient.reference", "short": "Literal reference, Relative, internal or absolute URL", "definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.", "comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.", "min": 0, "max": "1", "base": { "path": "Reference.reference", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ref-2", "ref-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Communication.recipient.type", "path": "Communication.recipient.type", "short": "Type the reference refers to (e.g. \"Patient\") - must be a resource in resources", "definition": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).", "comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.", "min": 0, "max": "0", "base": { "path": "Reference.type", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "Aa resource (or, for logical models, the URI of the logical model)." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "FHIRResourceTypeExt" } ], "strength": "extensible", "description": "Aa resource (or, for logical models, the URI of the logical model).", "valueSet": "http://hl7.org/fhir/ValueSet/resource-types" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Communication.recipient.identifier", "path": "Communication.recipient.identifier", "short": "Logical reference, when literal reference is not known", "definition": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.", "comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).\n\nThis element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.", "min": 0, "max": "0", "base": { "path": "Reference.identifier", "min": 0, "max": "1" }, "type": [ { "code": "Identifier" } ], "condition": [ "ref-2" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ident-1", "severity": "warning", "human": "Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason", "expression": "value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Identifier" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)" }, { "identity": "rim", "map": "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]" }, { "identity": "servd", "map": "Identifier" }, { "identity": "rim", "map": ".identifier" } ] }, { "id": "Communication.recipient.display", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Communication.recipient.display", "short": "Text alternative for the resource", "definition": "Plain text narrative that identifies the resource in addition to the resource reference.", "comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.", "min": 0, "max": "1", "base": { "path": "Reference.display", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ref-2" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Communication.sender", "path": "Communication.sender", "short": "Who shares the information", "definition": "#### **_`IDMS: If DIRECT is doing the receiving then the reference will be populated with a reference to the Organization and display will be populated with the Organization Namee. If DIRECT is sending then the reference is null and the display = DIRECT`_**", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "min": 1, "max": "1", "base": { "path": "Communication.sender", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))", "source": "http://hl7.org/fhir/StructureDefinition/Reference" }, { "key": "ref-2", "severity": "error", "human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).", "expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "workflow", "map": "Event.performer.actor" }, { "identity": "w5", "map": "FiveWs.actor" } ] }, { "id": "Communication.sender.id", "path": "Communication.sender.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "condition": [ "ele-1" ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Communication.sender.extension", "path": "Communication.sender.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "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 managable, 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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Communication.sender.reference", "path": "Communication.sender.reference", "short": "Literal reference, Relative, internal or absolute URL", "definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.", "comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.", "min": 0, "max": "1", "base": { "path": "Reference.reference", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ref-2", "ref-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Communication.sender.type", "path": "Communication.sender.type", "short": "Type the reference refers to (e.g. \"Patient\") - must be a resource in resources", "definition": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).", "comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.", "min": 0, "max": "0", "base": { "path": "Reference.type", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "Aa resource (or, for logical models, the URI of the logical model)." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "FHIRResourceTypeExt" } ], "strength": "extensible", "description": "Aa resource (or, for logical models, the URI of the logical model).", "valueSet": "http://hl7.org/fhir/ValueSet/resource-types" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Communication.sender.identifier", "path": "Communication.sender.identifier", "short": "Logical reference, when literal reference is not known", "definition": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.", "comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).\n\nThis element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.", "min": 0, "max": "0", "base": { "path": "Reference.identifier", "min": 0, "max": "1" }, "type": [ { "code": "Identifier" } ], "condition": [ "ref-2" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ident-1", "severity": "warning", "human": "Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason", "expression": "value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Identifier" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)" }, { "identity": "rim", "map": "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]" }, { "identity": "servd", "map": "Identifier" }, { "identity": "rim", "map": ".identifier" } ] }, { "id": "Communication.sender.display", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Communication.sender.display", "short": "Text alternative for the resource", "definition": "Plain text narrative that identifies the resource in addition to the resource reference.", "comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.", "min": 0, "max": "1", "base": { "path": "Reference.display", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ref-2" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Communication.reason", "path": "Communication.reason", "short": "Indication for message", "definition": "The reason or justification for the communication.", "comment": "Textual reasons can be captured using reason.concept.text.", "min": 0, "max": "0", "base": { "path": "Communication.reason", "min": 0, "max": "*" }, "type": [ { "code": "CodeableReference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CommunicationReason" } ], "strength": "example", "description": "Codes for describing reasons for the occurrence of a communication.", "valueSet": "http://hl7.org/fhir/ValueSet/clinical-findings" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "Event.reason" }, { "identity": "w5", "map": "FiveWs.why[x]" }, { "identity": "rim", "map": ".reasonCode" } ] }, { "id": "Communication.payload", "path": "Communication.payload", "short": "Message payload", "definition": "#### **_`IDMS: There are two types of payloads, the attachment stored in the BINARY and the attachment stored in SHAREPOINT.`_**", "min": 0, "max": "*", "base": { "path": "Communication.payload", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Communication.payload.id", "path": "Communication.payload.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "condition": [ "ele-1" ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Communication.payload.extension", "path": "Communication.payload.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "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 managable, 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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Communication.payload.modifierExtension", "path": "Communication.payload.modifierExtension", "short": "Extensions that cannot be ignored even if unrecognized", "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 managable, 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).", "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.", "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](extensibility.html#modifierExtension).", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Communication.payload.content[x]", "path": "Communication.payload.content[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "ordered": false, "rules": "open" }, "short": "Message part content", "definition": "A communicated content (or for multi-part communications, one portion of the communication).", "comment": "The content can be codified or textual. As an example of codified content, when working with machine generated communications, the payload may be drawn from a finite, terminology defined set of communications, especially for short, status update kinds of communications where more of a natural language approach isn't appropriate.\n\nIf the content isn't codified, contentCodeableConcept.text can be used. \n\nWhen using contentCodeableConcept, the CodeableConcept is what is being communicated and is not a categorization of the content.", "min": 1, "max": "1", "base": { "path": "Communication.payload.content[x]", "min": 1, "max": "1" }, "type": [ { "code": "Attachment" }, { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] }, { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Communication.payload.content[x]:contentCodeableConcept", "path": "Communication.payload.content[x]", "sliceName": "contentCodeableConcept", "short": "Message part content", "definition": "A communicated content (or for multi-part communications, one portion of the communication).", "comment": "The content can be codified or textual. As an example of codified content, when working with machine generated communications, the payload may be drawn from a finite, terminology defined set of communications, especially for short, status update kinds of communications where more of a natural language approach isn't appropriate.\n\nIf the content isn't codified, contentCodeableConcept.text can be used. \n\nWhen using contentCodeableConcept, the CodeableConcept is what is being communicated and is not a categorization of the content.", "min": 0, "max": "0", "base": { "path": "Communication.payload.content[x]", "min": 1, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Communication.payload.content[x]:contentAttachment", "path": "Communication.payload.content[x]", "sliceName": "contentAttachment", "short": "Message part content", "definition": "A communicated content (or for multi-part communications, one portion of the communication).", "comment": "The content can be codified or textual. As an example of codified content, when working with machine generated communications, the payload may be drawn from a finite, terminology defined set of communications, especially for short, status update kinds of communications where more of a natural language approach isn't appropriate.\n\nIf the content isn't codified, contentCodeableConcept.text can be used. \n\nWhen using contentCodeableConcept, the CodeableConcept is what is being communicated and is not a categorization of the content.", "min": 1, "max": "1", "base": { "path": "Communication.payload.content[x]", "min": 1, "max": "1" }, "type": [ { "code": "Attachment" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Communication.payload.content[x]:contentAttachment.id", "path": "Communication.payload.content[x].id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "condition": [ "ele-1" ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Communication.payload.content[x]:contentAttachment.extension", "path": "Communication.payload.content[x].extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "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 managable, 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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Communication.payload.content[x]:contentAttachment.extension:documentManagmentLocation", "path": "Communication.payload.content[x].extension", "sliceName": "documentManagmentLocation", "short": "Optional Extensions Element", "definition": "#### **_`SHAREPOINT: 'SharePoint'. BINARY: It is not populated.`_**", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "1", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "https://health.gov.on.ca/idms/fhir/StructureDefinition/DocumentManagmentLocation" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Communication.payload.content[x]:contentAttachment.contentType", "path": "Communication.payload.content[x].contentType", "short": "Mime type of the content, with charset etc.", "definition": "#### **_`SHAREPOINT and BINARY: 'application/pdf'`_**", "comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size", "requirements": "Processors of the data need to be able to know how to interpret the data.", "min": 1, "max": "1", "base": { "path": "Attachment.contentType", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "example": [ { "label": "General", "valueCode": "text/plain; charset=UTF-8, image/png" } ], "condition": [ "att-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "The mime type of an attachment. Any valid mime type is allowed." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MimeType" } ], "strength": "required", "description": "BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)", "valueSet": "http://hl7.org/fhir/ValueSet/mimetypes|5.0.0" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used" }, { "identity": "rim", "map": "./mediaType, ./charset" } ] }, { "id": "Communication.payload.content[x]:contentAttachment.language", "path": "Communication.payload.content[x].language", "short": "Human language of the content (BCP-47)", "definition": "The human language of the content. The value can be any valid value according to BCP 47.", "comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size", "requirements": "Users need to be able to choose between the languages in a set of attachments.", "min": 0, "max": "0", "base": { "path": "Attachment.language", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "example": [ { "label": "General", "valueCode": "en-AU" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "IETF language tag for a human language." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" } ], "strength": "required", "description": "IETF language tag for a human language.", "valueSet": "http://hl7.org/fhir/ValueSet/all-languages|5.0.0", "additional": [ { "purpose": "starter", "valueSet": "http://hl7.org/fhir/ValueSet/languages" } ] }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "./language" } ] }, { "id": "Communication.payload.content[x]:contentAttachment.data", "path": "Communication.payload.content[x].data", "short": "Data inline, base64ed", "definition": "The actual data of the attachment - a sequence of bytes, base64 encoded.", "comment": "The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.", "requirements": "The data needs to able to be transmitted inline.", "min": 0, "max": "0", "base": { "path": "Attachment.data", "min": 0, "max": "1" }, "type": [ { "code": "base64Binary" } ], "condition": [ "att-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "ED.5" }, { "identity": "rim", "map": "./data" } ] }, { "id": "Communication.payload.content[x]:contentAttachment.url", "path": "Communication.payload.content[x].url", "short": "Uri where the data can be found", "definition": "#### **_`SHAREPOINT: The name of the file. BINARY: The Binary resource id.`_**", "comment": "If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.", "requirements": "The data needs to be transmitted by reference.", "min": 1, "max": "1", "base": { "path": "Attachment.url", "min": 0, "max": "1" }, "type": [ { "code": "url" } ], "example": [ { "label": "General", "valueUrl": "http://www.acme.com/logo-small.png" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "RP.1+RP.2 - if they refer to a URL (see v2.6)" }, { "identity": "rim", "map": "./reference/literal" } ] }, { "id": "Communication.payload.content[x]:contentAttachment.size", "path": "Communication.payload.content[x].size", "short": "Number of bytes of content (if url provided)", "definition": "The number of bytes of data that make up this attachment (before base64 encoding, if that is done).", "comment": "The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.", "requirements": "Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.", "min": 0, "max": "0", "base": { "path": "Attachment.size", "min": 0, "max": "1" }, "type": [ { "code": "integer64" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A (needs data type R3 proposal)" } ] }, { "id": "Communication.payload.content[x]:contentAttachment.hash", "path": "Communication.payload.content[x].hash", "short": "Hash of the data (sha-1, base64ed)", "definition": "The calculated hash of the data using SHA-1. Represented using base64.", "comment": "The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see [Provenance.signature](provenance-definitions.html#Provenance.signature) for mechanism to protect a resource with a digital signature.", "requirements": "Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).", "min": 0, "max": "0", "base": { "path": "Attachment.hash", "min": 0, "max": "1" }, "type": [ { "code": "base64Binary" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": ".integrityCheck[parent::ED/integrityCheckAlgorithm=\"SHA-1\"]" } ] }, { "id": "Communication.payload.content[x]:contentAttachment.title", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Communication.payload.content[x].title", "short": "Label to display in place of the data", "definition": "#### **_`SHAREPOINT and BINARY: 'Submission Summary'`_**", "comment": "May sometimes be derived from the source filename.", "requirements": "Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.", "min": 1, "max": "1", "base": { "path": "Attachment.title", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "example": [ { "label": "General", "valueString": "Official Corporate Logo" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "./title/data" } ] }, { "id": "Communication.payload.content[x]:contentAttachment.creation", "path": "Communication.payload.content[x].creation", "short": "Date attachment was first created", "definition": "The date that the attachment was first created.", "comment": "UTC offset is allowed for dates and partial dates", "requirements": "This is often tracked as an integrity issue for use of the attachment.", "min": 0, "max": "0", "base": { "path": "Attachment.creation", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A (needs data type R3 proposal)" } ] }, { "id": "Communication.payload.content[x]:contentAttachment.height", "path": "Communication.payload.content[x].height", "short": "Height of the image in pixels (photo/video)", "definition": "Height of the image in pixels (photo/video).", "comment": "32 bit number; for values larger than this, use decimal", "min": 0, "max": "0", "base": { "path": "Attachment.height", "min": 0, "max": "1" }, "type": [ { "code": "positiveInt" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value" } ] }, { "id": "Communication.payload.content[x]:contentAttachment.width", "path": "Communication.payload.content[x].width", "short": "Width of the image in pixels (photo/video)", "definition": "Width of the image in pixels (photo/video).", "comment": "32 bit number; for values larger than this, use decimal", "min": 0, "max": "0", "base": { "path": "Attachment.width", "min": 0, "max": "1" }, "type": [ { "code": "positiveInt" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value" } ] }, { "id": "Communication.payload.content[x]:contentAttachment.frames", "path": "Communication.payload.content[x].frames", "short": "Number of frames if > 1 (photo)", "definition": "The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.", "comment": "if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.", "min": 0, "max": "0", "base": { "path": "Attachment.frames", "min": 0, "max": "1" }, "type": [ { "code": "positiveInt" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value" } ] }, { "id": "Communication.payload.content[x]:contentAttachment.duration", "path": "Communication.payload.content[x].duration", "short": "Length in seconds (audio / video)", "definition": "The duration of the recording in seconds - for audio and video.", "comment": "The duration might differ from occurrencePeriod if recording was paused.", "min": 0, "max": "0", "base": { "path": "Attachment.duration", "min": 0, "max": "1" }, "type": [ { "code": "decimal" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value" } ] }, { "id": "Communication.payload.content[x]:contentAttachment.pages", "path": "Communication.payload.content[x].pages", "short": "Number of printed pages", "definition": "The number of pages when printed.", "comment": "32 bit number; for values larger than this, use decimal", "min": 0, "max": "0", "base": { "path": "Attachment.pages", "min": 0, "max": "1" }, "type": [ { "code": "positiveInt" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Communication.payload.content[x]:contentReference", "path": "Communication.payload.content[x]", "sliceName": "contentReference", "short": "Message part content", "definition": "A communicated content (or for multi-part communications, one portion of the communication).", "comment": "The content can be codified or textual. As an example of codified content, when working with machine generated communications, the payload may be drawn from a finite, terminology defined set of communications, especially for short, status update kinds of communications where more of a natural language approach isn't appropriate.\n\nIf the content isn't codified, contentCodeableConcept.text can be used. \n\nWhen using contentCodeableConcept, the CodeableConcept is what is being communicated and is not a categorization of the content.", "min": 0, "max": "0", "base": { "path": "Communication.payload.content[x]", "min": 1, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Communication.note", "path": "Communication.note", "short": "Comments made about the communication", "definition": "#### **_`IDMS: This is a description of what the client asked to be changed. Example: (Custom Status = 'Processed', Request Status = 'Completed') This will appear on the UI under Communication History`_**\n\nAdditional notes or commentary about the communication by the sender, receiver or other interested parties.", "comment": "For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. *Annotations SHOULD NOT* be used to communicate \"modifying\" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).", "min": 0, "max": "0", "base": { "path": "Communication.note", "min": 0, "max": "*" }, "type": [ { "code": "Annotation" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Act" }, { "identity": "workflow", "map": "Event.note" } ] }, { "id": "Communication.reasonCode", "path": "Communication.reasonCode", "max": "0", "base": { "path": "Communication.reasonCode", "max": "0" } }, { "id": "Communication.reasonReference", "path": "Communication.reasonReference", "max": "0", "base": { "path": "Communication.reasonReference", "max": "0" } } ] }, "differential": { "element": [ { "id": "Communication", "path": "Communication", "definition": "#### **_`IDMS: This is used to record data exchanges between IDMS and Client Systems. This includes sending submission data and the client sending status updates and files`_**\n\n\nAn occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition." }, { "id": "Communication.extension", "path": "Communication.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" }, "min": 0 }, { "id": "Communication.extension:externalIndicator", "path": "Communication.extension", "sliceName": "externalIndicator", "definition": "#### **_`IDMS: Indicates this is was created by external user.`_**", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://health.gov.on.ca/idms/fhir/StructureDefinition/Extension-External-Indicator" ] } ] }, { "id": "Communication.identifier", "path": "Communication.identifier", "max": "0" }, { "id": "Communication.instantiatesCanonical", "path": "Communication.instantiatesCanonical", "max": "0" }, { "id": "Communication.instantiatesUri", "path": "Communication.instantiatesUri", "max": "0" }, { "id": "Communication.basedOn", "path": "Communication.basedOn", "definition": "#### **_`IDMS: This is a reference to the Request.`_**\n\nAn order, proposal or plan fulfilled in whole or in part by this Communication.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": [ "https://health.gov.on.ca/idms/fhir/StructureDefinition/IDMS-ServiceRequest-New" ] } ] }, { "id": "Communication.partOf", "path": "Communication.partOf", "definition": "#### **_`IDMS: If this is an Additional Information Submission communication this is a reference to that Child Request.`_**", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": [ "https://health.gov.on.ca/idms/fhir/StructureDefinition/IDMS-ServiceRequest-Child-Submission" ] } ] }, { "id": "Communication.inResponseTo", "path": "Communication.inResponseTo", "max": "0" }, { "id": "Communication.status", "path": "Communication.status", "definition": "#### **_`IDMS: Use 'completed' if it was sucessful and 'entered-in-error' for errors.`_**\n\nThe status of the transmission." }, { "id": "Communication.statusReason", "path": "Communication.statusReason", "definition": "#### **_`IDMS: This is the code for the IDMS error message.`_**\n\nThe status of the transmission.", "max": "0", "binding": { "strength": "required", "valueSet": "http://health.gov.on.ca/sadie/fhir/ValueSet/FlexForms-ClientCommunication-Errors" } }, { "id": "Communication.category", "path": "Communication.category", "definition": "#### **_`SUBMISSION`_**\n #### **_`code:COMMUNICATION-TYPE-SUBMISSION ; system:https://health.gov.on.ca/idms/fhir/CodeSystem/IDMS-Internal ; display:Request Submitted `_**\n\n #### **_`ADDITIONAL INFORMATION`_**\n #### **_`code: COMMUNICATION-TYPE-ADDITIONAL-INFO; system:https://health.gov.on.ca/idms/fhir/CodeSystem/IDMS-Internal ; display:Additional Information Submitted `_**", "max": "1", "binding": { "strength": "required", "valueSet": "http://health.gov.on.ca/sadie/fhir/ValueSet/FlexForms-CommunicationTypes" } }, { "id": "Communication.priority", "path": "Communication.priority", "max": "0" }, { "id": "Communication.medium", "path": "Communication.medium", "max": "0" }, { "id": "Communication.subject", "path": "Communication.subject", "max": "0" }, { "id": "Communication.subject.reference", "path": "Communication.subject.reference", "max": "0" }, { "id": "Communication.subject.type", "path": "Communication.subject.type", "max": "0" }, { "id": "Communication.subject.identifier", "path": "Communication.subject.identifier", "max": "0" }, { "id": "Communication.subject.display", "path": "Communication.subject.display", "max": "0" }, { "id": "Communication.topic", "path": "Communication.topic", "max": "0" }, { "id": "Communication.about", "path": "Communication.about", "max": "0" }, { "id": "Communication.about.reference", "path": "Communication.about.reference", "max": "0" }, { "id": "Communication.about.type", "path": "Communication.about.type", "max": "0" }, { "id": "Communication.about.identifier", "path": "Communication.about.identifier", "max": "0" }, { "id": "Communication.about.display", "path": "Communication.about.display", "max": "0" }, { "id": "Communication.encounter", "path": "Communication.encounter", "max": "0" }, { "id": "Communication.sent", "path": "Communication.sent", "definition": "#### **_`IDMS: If DIRECT is doing the sending then this is populated otherwise it is null`_**\n\nThe time when this communication was sent." }, { "id": "Communication.received", "path": "Communication.received", "definition": "#### **_`IDMS: If DIRECT is doing the receiving then this is populated otherwise it is null`_**\n\nThe time when this communication arrived at the destination." }, { "id": "Communication.recipient", "path": "Communication.recipient", "definition": "#### **_`IDMS: If DIRECT is doing the sending then the reference will be populated with a reference to the Organization and display will be populated with the Organization Name. If DIRECT is receiving then the reference is null and the display = DIRECT`_**\n\n\n.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ] }, { "id": "Communication.recipient.type", "path": "Communication.recipient.type", "max": "0" }, { "id": "Communication.recipient.identifier", "path": "Communication.recipient.identifier", "max": "0" }, { "id": "Communication.sender", "path": "Communication.sender", "definition": "#### **_`IDMS: If DIRECT is doing the receiving then the reference will be populated with a reference to the Organization and display will be populated with the Organization Namee. If DIRECT is sending then the reference is null and the display = DIRECT`_**", "min": 1, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ] }, { "id": "Communication.sender.type", "path": "Communication.sender.type", "max": "0" }, { "id": "Communication.sender.identifier", "path": "Communication.sender.identifier", "max": "0" }, { "id": "Communication.reason", "path": "Communication.reason", "max": "0" }, { "id": "Communication.reasonCode", "path": "Communication.reasonCode", "max": "0" }, { "id": "Communication.reasonReference", "path": "Communication.reasonReference", "max": "0" }, { "id": "Communication.payload", "path": "Communication.payload", "definition": "#### **_`IDMS: There are two types of payloads, the attachment stored in the BINARY and the attachment stored in SHAREPOINT.`_**" }, { "id": "Communication.payload.contentCodeableConcept", "path": "Communication.payload.contentCodeableConcept", "max": "0" }, { "id": "Communication.payload.contentAttachment", "path": "Communication.payload.contentAttachment", "min": 1 }, { "id": "Communication.payload.contentAttachment.extension", "path": "Communication.payload.contentAttachment.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" } }, { "id": "Communication.payload.contentAttachment.extension:documentManagmentLocation", "path": "Communication.payload.contentAttachment.extension", "sliceName": "documentManagmentLocation", "definition": "#### **_`SHAREPOINT: 'SharePoint'. BINARY: It is not populated.`_**", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://health.gov.on.ca/idms/fhir/StructureDefinition/DocumentManagmentLocation" ] } ] }, { "id": "Communication.payload.contentAttachment.contentType", "path": "Communication.payload.contentAttachment.contentType", "definition": "#### **_`SHAREPOINT and BINARY: 'application/pdf'`_**", "min": 1 }, { "id": "Communication.payload.contentAttachment.language", "path": "Communication.payload.contentAttachment.language", "max": "0" }, { "id": "Communication.payload.contentAttachment.data", "path": "Communication.payload.contentAttachment.data", "max": "0" }, { "id": "Communication.payload.contentAttachment.url", "path": "Communication.payload.contentAttachment.url", "definition": "#### **_`SHAREPOINT: The name of the file. BINARY: The Binary resource id.`_**", "min": 1 }, { "id": "Communication.payload.contentAttachment.size", "path": "Communication.payload.contentAttachment.size", "max": "0" }, { "id": "Communication.payload.contentAttachment.hash", "path": "Communication.payload.contentAttachment.hash", "max": "0" }, { "id": "Communication.payload.contentAttachment.title", "path": "Communication.payload.contentAttachment.title", "definition": "#### **_`SHAREPOINT and BINARY: 'Submission Summary'`_**", "min": 1 }, { "id": "Communication.payload.contentAttachment.creation", "path": "Communication.payload.contentAttachment.creation", "max": "0" }, { "id": "Communication.payload.contentAttachment.height", "path": "Communication.payload.contentAttachment.height", "max": "0" }, { "id": "Communication.payload.contentAttachment.width", "path": "Communication.payload.contentAttachment.width", "max": "0" }, { "id": "Communication.payload.contentAttachment.frames", "path": "Communication.payload.contentAttachment.frames", "max": "0" }, { "id": "Communication.payload.contentAttachment.duration", "path": "Communication.payload.contentAttachment.duration", "max": "0" }, { "id": "Communication.payload.contentAttachment.pages", "path": "Communication.payload.contentAttachment.pages", "max": "0" }, { "id": "Communication.payload.contentReference", "path": "Communication.payload.contentReference", "max": "0" }, { "id": "Communication.note", "path": "Communication.note", "definition": "#### **_`IDMS: This is a description of what the client asked to be changed. Example: (Custom Status = 'Processed', Request Status = 'Completed') This will appear on the UI under Communication History`_**\n\nAdditional notes or commentary about the communication by the sender, receiver or other interested parties.", "max": "0" } ] } }