{ "resourceType": "StructureDefinition", "id": "315", "url": "http://lifen.fr/fhir/StructureDefinition/LifenCommunicationRequestCoreProfile-v2", "name": "Lifen CommunicationRequest Core Profile V2", "status": "active", "version": "2.0.0", "fhirVersion": "3.0.2", "mapping": [ { "identity": "workflow", "uri": "http://hl7.org/fhir/workflow", "name": "Workflow Mapping" }, { "identity": "w5", "uri": "http://hl7.org/fhir/w5", "name": "W5 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "resource", "abstract": false, "type": "CommunicationRequest", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/CommunicationRequest", "derivation": "constraint", "snapshot": { "element": [ { "id": "CommunicationRequest", "path": "CommunicationRequest", "short": "A request for information to be sent to a receiver", "definition": "A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.", "min": 0, "max": "*", "base": { "path": "Resource", "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()", "xpath": "not(parent::f:contained and f:contained)" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)" }, { "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()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))" }, { "key": "cmr-lifen-1", "severity": "error", "human": "The communication request with status active SHALL have a recipient, a sender and a category", "expression": "status != 'active' or (recipient.exists() and sender.exists() and category.exists())" }, { "key": "cmr-lifen-2", "severity": "error", "human": "The communication request with status active and category MEDICAL_REPORT SHALL have a payload", "expression": "status != 'active' or category.coding.code != 'MEDICAL_REPORT' or payload.exists()" }, { "key": "cmr-lifen-3", "severity": "error", "human": "The communication request with status active and category MEDICAL_REPORT_COLOR SHALL have a payload", "expression": "status != 'active' or category.coding.code != 'MEDICAL_REPORT_COLOR' or payload.exists()" }, { "key": "cmr-lifen-4", "severity": "error", "human": "The communication request with status active and category CANCELLATION_DOCUMENT SHALL have a payload", "expression": "status != 'active' or category.coding.code != 'CANCELLATION_DOCUMENT' or payload.exists()" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Request" }, { "identity": "w5", "map": "workflow.order" } ] }, { "id": "CommunicationRequest.id", "path": "CommunicationRequest.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": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.", "min": 0, "max": "1", "base": { "path": "Resource.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "CommunicationRequest.meta", "path": "CommunicationRequest.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 may 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", "profile": "http://lifen.fr/fhir/StructureDefinition/LifenMetaCoreProfile-v2" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "CommunicationRequest.meta.id", "path": "CommunicationRequest.meta.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "CommunicationRequest.meta.extension", "path": "CommunicationRequest.meta.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "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" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "CommunicationRequest.meta.versionId", "path": "CommunicationRequest.meta.versionId", "short": "Version specific identifier", "definition": "The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.", "comment": "The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.", "min": 0, "max": "1", "base": { "path": "Meta.versionId", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "CommunicationRequest.meta.lastUpdated", "path": "CommunicationRequest.meta.lastUpdated", "short": "When the resource version last changed", "definition": "When the resource last changed - e.g. when the version changed.", "comment": "This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.", "min": 0, "max": "1", "base": { "path": "Meta.lastUpdated", "min": 0, "max": "1" }, "type": [ { "code": "instant" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "CommunicationRequest.meta.profile", "path": "CommunicationRequest.meta.profile", "short": "Profiles this resource claims to conform to", "definition": "A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url]().", "comment": "It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.", "min": 0, "max": "*", "base": { "path": "Meta.profile", "min": 0, "max": "*" }, "type": [ { "code": "uri" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "CommunicationRequest.meta.security", "path": "CommunicationRequest.meta.security", "short": "Security Labels applied to this resource", "definition": "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.", "comment": "The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.", "min": 0, "max": "*", "base": { "path": "Meta.security", "min": 0, "max": "*" }, "type": [ { "code": "Coding" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SecurityLabels" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "description": "Security Labels from the Healthcare Privacy and Security Classification System.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/security-labels" } }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6" }, { "identity": "rim", "map": "CV" }, { "identity": "orim", "map": "fhir:Coding rdfs:subClassOf dt:CDCoding" } ] }, { "id": "CommunicationRequest.meta.tag", "path": "CommunicationRequest.meta.tag", "short": "Tags applied to this resource", "definition": "Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.", "comment": "The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.", "min": 0, "max": "*", "base": { "path": "Meta.tag", "min": 0, "max": "*" }, "type": [ { "code": "Coding" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "binding": { "strength": "required", "description": "LifenValueSetCommunicationRequestTag", "valueSetReference": { "reference": "http://lifen.fr/fhir/ValueSet/CommunicationRequest/Tags-v2" } }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6" }, { "identity": "rim", "map": "CV" }, { "identity": "orim", "map": "fhir:Coding rdfs:subClassOf dt:CDCoding" } ] }, { "id": "CommunicationRequest.implicitRules", "path": "CommunicationRequest.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.", "comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.", "min": 0, "max": "1", "base": { "path": "Resource.implicitRules", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "CommunicationRequest.language", "path": "CommunicationRequest.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" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueReference": { "reference": "http://hl7.org/fhir/ValueSet/all-languages" } }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "description": "A human language.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/languages" } }, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "CommunicationRequest.text", "path": "CommunicationRequest.text", "short": "Text summary of the resource, for human interpretation", "definition": "A human-readable narrative that contains a summary of the resource, and may 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 narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "base": { "path": "DomainResource.text", "min": 0, "max": "1" }, "type": [ { "code": "Narrative" } ], "condition": [ "ele-1", "dom-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" }, { "identity": "rim", "map": "Act.text?" } ] }, { "id": "CommunicationRequest.contained", "path": "CommunicationRequest.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, and nor can they have their own independent transaction scope.", "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.", "alias": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "0", "base": { "path": "DomainResource.contained", "min": 0, "max": "*" }, "type": [ { "code": "Resource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "CommunicationRequest.extension", "path": "CommunicationRequest.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "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" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "CommunicationRequest.extension:resendProcessed", "path": "CommunicationRequest.extension", "definition": "extension for resend processed CR", "min": 0, "max": "*", "sliceName": "resendProcessed", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/ResendProcessed-v2" } ] }, { "id": "CommunicationRequest.extension:threadOrigin", "path": "CommunicationRequest.extension", "definition": "extension for thread origin CR", "sliceName": "threadOrigin", "min": 0, "max": "*", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/ThreadOrigin-v2" } ] }, { "id": "CommunicationRequest.extension:messagingSubject", "path": "CommunicationRequest.extension", "definition": "extension for messaging subject CR", "min": 0, "max": "*", "sliceName": "messagingSubject", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/MessagingSubject-v2" } ] }, { "id": "CommunicationRequest.extension:automaticSending", "path": "CommunicationRequest.extension", "definition": "extension to enable automatic sending of the resource", "min": 0, "max": "*", "sliceName": "automaticSending", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/CommunicationRequest/Extension/AutomaticSending-v2" } ] }, { "id": "CommunicationRequest.extension:automaticSendingMainCron", "path": "CommunicationRequest.extension", "definition": "extension to enable automatic sending of the resource only on main cron (and not hourly, the default value)", "min": 0, "max": "1", "sliceName": "automaticSendingMainCron", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/CommunicationRequest/Extension/AutomaticSending-v2MainCron-v2" } ] }, { "id": "CommunicationRequest.extension:forward", "path": "CommunicationRequest.extension", "definition": "extension to store the initial sender of a forwarded document", "min": 0, "max": "*", "sliceName": "forward", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/Forward-v2" } ] }, { "id": "CommunicationRequest.extension:userVerificationNeededReason", "path": "CommunicationRequest.extension", "definition": "extension for user verification needed reason", "min": 0, "max": "*", "sliceName": "userVerificationNeededReason", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/CommunicationRequest/Extension/UserVerificationNeededReason-v2" } ] }, { "id": "CommunicationRequest.extension:skipDocTypeCheck", "path": "CommunicationRequest.extension", "definition": "extension to know if the document type check must be skipped", "min": 0, "max": "*", "sliceName": "skipDocTypeCheck", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/CommunicationRequest/Extension/SkipDocTypeCheck-v2" } ] }, { "id": "CommunicationRequest.extension:enrichmentManagedByBECA", "path": "CommunicationRequest.extension", "definition": "Specify if the enrichment of CommunicationRequest (ex. patient match) is done by BECA rather than legacy LFs", "min": 0, "max": "*", "sliceName": "enrichmentManagedByBECA", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/CommunicationRequest/Extension/EnrichmentManagedByBECA-v2" } ] }, { "id": "CommunicationRequest.extension:synchronousProcessing", "path": "CommunicationRequest.extension", "sliceName": "synchronousProcessing", "definition": "Specifies if a CommunicationRequest should be processed in a synchronous manner", "min": 0, "max": "1", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/CommunicationRequest/Extension/synchronousProcessing-v2" } ] }, { "id": "CommunicationRequest.extension:ENSStopConversationExtension", "path": "CommunicationRequest.extension", "sliceName": "ENSStopConversationExtension", "definition": "Specifies that the string of characters FIN has to be included to the SMTP header X-MSS-MES in the mail to the patient", "min": 0, "max": "1", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/ENSStopConversationExtension-v2" } ] }, { "id": "CommunicationRequest.extension:mailBodyTemplate", "path": "CommunicationRequest.extension", "sliceName": "mailBodyTemplate", "definition": "extension mailBodyTemplate", "min": 0, "max": "1", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/MailBodyTemplate-v2" } ] }, { "id": "CommunicationRequest.extension:sourceApplicationName", "path": "CommunicationRequest.extension", "sliceName": "sourceApplicationName", "definition": "Specify a valueString to identify the application name that created the resource.", "min": 0, "max": "1", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/SourceApplicationName" } ] }, { "id": "CommunicationRequest.extension:SendingRequestId", "path": "CommunicationRequest.extension", "sliceName": "SendingRequestId", "definition": "Identifier of the sending request (from a business point of view) in order to follow the full cycle of a sending request whitout having to do secondary search (heavy in resource)", "min": 0, "max": "1", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/SendingRequestId-v2" } ] }, { "id": "CommunicationRequest.extension:databaseReference", "path": "CommunicationRequest.extension", "sliceName": "databaseReference", "definition": "extension databaseReference - relation between an healthcare structure and a third app", "min": 0, "max": "1", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/DatabaseReference-v2" } ] }, { "id": "CommunicationRequest.extension:IdReplacedDocumentNotSentWithLifen", "path": "CommunicationRequest.extension", "definition": "Give the id of a document that hasn’t been sent with Lifen (i.e. no DocumentReference available for it) that a client ask to replace through MSS and/or DMP", "min": 0, "max": "*", "sliceName": "IdReplacedDocumentNotSentWithLifen", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/CommunicationRequest/Extension/IdReplacedDocumentNotSentWithLifen-v2" } ] }, { "id": "CommunicationRequest.modifierExtension", "path": "CommunicationRequest.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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.", "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.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "CommunicationRequest.identifier", "path": "CommunicationRequest.identifier", "short": "Unique identifier", "definition": "A unique ID of this request for reference purposes. It must be provided if user wants it returned as part of any output, otherwise it will be autogenerated, if needed, by CDS system. Does not need to be the actual ID of the source system.", "min": 0, "max": "*", "base": { "path": "CommunicationRequest.identifier", "min": 0, "max": "*" }, "type": [ { "code": "Identifier" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "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 - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. 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": "Request.identifier" }, { "identity": "w5", "map": "id" } ] }, { "id": "CommunicationRequest.basedOn", "path": "CommunicationRequest.basedOn", "short": "Fulfills plan or proposal", "definition": "A plan or proposal that is fulfilled in whole or in part by this request.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (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.", "requirements": "Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon.", "alias": [ "fulfills" ], "min": 0, "max": "*", "base": { "path": "CommunicationRequest.basedOn", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" } ], "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": "Request.basedOn" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=FLFS].target" } ] }, { "id": "CommunicationRequest.replaces", "path": "CommunicationRequest.replaces", "short": "Request(s) replaced by this request", "definition": "Completed or terminated request(s) whose function is taken by this new request.", "comment": "The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.", "requirements": "Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.", "alias": [ "supersedes", "prior" ], "min": 0, "max": "*", "base": { "path": "CommunicationRequest.replaces", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/CommunicationRequest" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" } ], "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": "Request.replaces" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=RPLC].target" } ] }, { "id": "CommunicationRequest.groupIdentifier", "path": "CommunicationRequest.groupIdentifier", "short": "Composite request this is part of", "definition": "A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.", "comment": "Requests are linked either by a \"basedOn\" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.", "alias": [ "grouperId" ], "min": 0, "max": "1", "base": { "path": "CommunicationRequest.groupIdentifier", "min": 0, "max": "1" }, "type": [ { "code": "Identifier" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "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 - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. 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": "Request.groupIdentifier" }, { "identity": "rim", "map": ".inboundRelationship(typeCode=COMP].source[moodCode=INT].identifier" } ] }, { "id": "CommunicationRequest.status", "path": "CommunicationRequest.status", "short": "draft | active | suspended | cancelled | completed | entered-in-error | unknown", "definition": "The status of the proposal or order.", "comment": "This element is labeled as a modifier because the status contains the codes cancelled and entered-in-error that mark the request as not currently valid.", "min": 1, "max": "1", "base": { "path": "CommunicationRequest.status", "min": 1, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CommunicationRequestStatus" } ], "strength": "required", "description": "The status of the communication request.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/request-status" } }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "Request.status" }, { "identity": "w5", "map": "status" } ] }, { "id": "CommunicationRequest.category", "path": "CommunicationRequest.category", "short": "Message category", "definition": "The type of message to be sent such as medical report, cancel, replacement, ...", "comment": "There may be multiple axes of categorization and one communication request may serve multiple purposes.", "min": 0, "max": "*", "base": { "path": "CommunicationRequest.category", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "binding": { "strength": "required", "description": "Codes for general categories of communications such as cancel, replacement, ...", "valueSetReference": { "reference": "http://lifen.fr/fhir/ValueSet/Resource/Category-v2" } }, "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": "Request.code" }, { "identity": "w5", "map": "class" } ] }, { "id": "CommunicationRequest.priority", "path": "CommunicationRequest.priority", "short": "Message urgency", "definition": "Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "CommunicationRequest.priority", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "meaningWhenMissing": "If missing, this task should be performed with normal priority", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "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 request.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/request-priority" } }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "Request.priority" }, { "identity": "w5", "map": "grade" } ] }, { "id": "CommunicationRequest.medium", "path": "CommunicationRequest.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": "*", "base": { "path": "CommunicationRequest.medium", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "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.", "valueSetReference": { "reference": "http://hl7.org/fhir/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": "CommunicationRequest.subject", "path": "CommunicationRequest.subject", "short": "Focus of message", "definition": "The patient or group that is the focus of this communication request.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (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": "1", "base": { "path": "CommunicationRequest.subject", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" } ], "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": "Request.subject" }, { "identity": "w5", "map": "who.focus" } ] }, { "id": "CommunicationRequest.recipient", "path": "CommunicationRequest.recipient", "short": "Message recipient", "definition": "The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (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": "*", "base": { "path": "CommunicationRequest.recipient", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/CareTeam" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" } ], "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": "Request.performer" }, { "identity": "w5", "map": "who.focus" } ] }, { "id": "CommunicationRequest.recipient.extension", "path": "CommunicationRequest.recipient.extension", "definition": "Extension of recipient on CR", "min": 0, "max": "*", "base": { "path": "CommunicationRequest.recipient.extension", "min": 0, "max": "*" }, "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" }, "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ] }, { "id": "CommunicationRequest.recipient.extension:recipientDetails", "path": "CommunicationRequest.recipient.extension", "definition": "Recipient details extension on CR", "sliceName": "recipientDetails", "min": 0, "max": "1", "base": { "path": "CommunicationRequest.recipient.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/communicationrequest-recipient-details-v2" } ] }, { "id": "CommunicationRequest.recipient.extension:practitionerrole", "path": "CommunicationRequest.recipient.extension", "definition": "Recipient extension to bind PractitionerRole associated to this recipient", "sliceName": "practitionerrole", "min": 0, "max": "1", "base": { "path": "CommunicationRequest.recipient.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/PractitionerRole-v2" } ] }, { "id": "CommunicationRequest.recipient.extension:trustedContact", "path": "CommunicationRequest.recipient.extension", "definition": "Extension to mark this recipient as a trusted contact rather than a patient", "sliceName": "trustedContact", "min": 0, "max": "1", "base": { "path": "CommunicationRequest.recipient.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Recipient/Extension/TrustedContact-v2" } ] }, { "id": "CommunicationRequest.recipient.extension:hl7information", "path": "CommunicationRequest.recipient.extension", "definition": "Recipient extension to bind hl7 information associated to this recipient", "sliceName": "hl7information", "min": 0, "max": "1", "base": { "path": "CommunicationRequest.recipient.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/CommunicationRequest/Extension/Recipient/HL7Information-v2" } ] }, { "id": "CommunicationRequest.recipient.extension:UnbillabilityReason", "path": "CommunicationRequest.recipient.extension", "definition": "Indicates the reason why a communication is not billed to client", "sliceName": "UnbillabilityReason", "min": 0, "max": "1", "base": { "path": "CommunicationRequest.recipient.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/UnbillabilityReason-v2" } ] }, { "id": "CommunicationRequest.recipient.extension:RecipientId", "path": "CommunicationRequest.recipient.extension", "definition": "Identifier of the sending operation in order to follow the full cycle of a sending request for one specific recipient whitout having to do secondary search (heavy in resource)", "sliceName": "RecipientId", "min": 0, "max": "1", "base": { "path": "CommunicationRequest.recipient.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/RecipientId-v2" } ] }, { "id": "CommunicationRequest.topic", "path": "CommunicationRequest.topic", "short": "Focal resources", "definition": "The resources which were related to producing this communication request.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (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": "*", "base": { "path": "CommunicationRequest.topic", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" } ], "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": "Request.supportingInfo" }, { "identity": "w5", "map": "context" } ] }, { "id": "CommunicationRequest.topic.extension", "path": "CommunicationRequest.topic.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Focal resources extension", "definition": "The resources which were related to producing this communication request.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (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": "*", "base": { "path": "CommunicationRequest.topic.extension", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" } ], "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": "Request.supportingInfo" }, { "identity": "w5", "map": "context" } ] }, { "id": "CommunicationRequest.topic.extension:type", "path": "CommunicationRequest.topic.extension", "sliceName": "type", "short": "Optional Extensions Element", "definition": "Optional Extension Element - found in all resources.", "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": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/Topic/Type-v2" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "CommunicationRequest.context", "path": "CommunicationRequest.context", "short": "Encounter or episode leading to message", "definition": "The encounter or episode of care within which the communication request was created.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (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": [ "encounter" ], "min": 0, "max": "1", "base": { "path": "CommunicationRequest.context", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" } ], "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": "Request.context" }, { "identity": "w5", "map": "context" } ] }, { "id": "CommunicationRequest.payload", "path": "CommunicationRequest.payload", "short": "Message payload", "definition": "Text, attachment(s), or resource(s) to be communicated to the recipient.", "min": 0, "max": "*", "base": { "path": "CommunicationRequest.payload", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "CommunicationRequest.payload.id", "path": "CommunicationRequest.payload.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "CommunicationRequest.payload.extension", "path": "CommunicationRequest.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "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" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "CommunicationRequest.payload.modifierExtension", "path": "CommunicationRequest.payload.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.", "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", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "CommunicationRequest.payload.content[x]", "path": "CommunicationRequest.payload.content[x]", "short": "Message part content", "definition": "The communicated content (or for multi-part communications, one portion of the communication).", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 1, "max": "1", "base": { "path": "CommunicationRequest.payload.content[x]", "min": 1, "max": "1" }, "type": [ { "code": "string" }, { "code": "Attachment" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "Request.supportingInfo IF Reference, Request.note if string; No mapping if Attachment" } ] }, { "id": "CommunicationRequest.payload.contentString.extension", "path": "CommunicationRequest.payload.contentString.extension", "short": "Additional Information defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "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.", "min": 0, "max": "*", "base": { "path": "CommunicationRequest.payload.contentString", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "CommunicationRequest.payload.contentString.extension:contentType", "path": "CommunicationRequest.payload.contentString.extension", "sliceName": "contentType", "definition": "extension to specify contentString contentType", "min": 0, "max": "1", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/Payload/ContentString/ContentType-v2" } ] }, { "id": "CommunicationRequest.occurrence[x]", "path": "CommunicationRequest.occurrence[x]", "short": "When scheduled", "definition": "The time when this communication is to occur.", "alias": [ "timing" ], "min": 0, "max": "1", "base": { "path": "CommunicationRequest.occurrence[x]", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" }, { "code": "Period" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "Request.occurrence" }, { "identity": "w5", "map": "when.planned" } ] }, { "id": "CommunicationRequest.authoredOn", "path": "CommunicationRequest.authoredOn", "short": "When request transitioned to being actionable", "definition": "For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.", "alias": [ "createdOn" ], "min": 0, "max": "1", "base": { "path": "CommunicationRequest.authoredOn", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "Request.authoredOn" }, { "identity": "w5", "map": "when.recorded" } ] }, { "id": "CommunicationRequest.sender", "path": "CommunicationRequest.sender", "short": "Message sender", "definition": "The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (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": "1", "base": { "path": "CommunicationRequest.sender", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" } ], "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": "Request.requester.agent" }, { "identity": "w5", "map": "who.actor" } ] }, { "id": "CommunicationRequest.sender.extension", "path": "CommunicationRequest.sender.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Focal resources extension", "definition": "The resources which were related to producing this communication request.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (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": "*", "base": { "path": "CommunicationRequest.sender.extension", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" } ], "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": "Request.supportingInfo" }, { "identity": "w5", "map": "context" } ] }, { "id": "CommunicationRequest.sender.extension:practitionerrole", "path": "CommunicationRequest.sender.extension", "definition": "Sender extension to bind PractitionerRole associated to this sender", "sliceName": "practitionerrole", "min": 0, "max": "1", "base": { "path": "CommunicationRequest.sender.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/PractitionerRole-v2" } ] }, { "id": "CommunicationRequest.sender.extension:FromMailAdd", "path": "CommunicationRequest.sender.extension", "definition": "Mail address to be used in the field “from” of the mail", "sliceName": "FromMailAdd", "min": 0, "max": "1", "base": { "path": "CommunicationRequest.sender.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/Sender/FromMailAdd-v2" } ] }, { "id": "CommunicationRequest.sender.extension:AppHelpDesk", "path": "CommunicationRequest.sender.extension", "definition": "Help Desk Mail address of the application which was used to send a MSS mail (eventually might be used for other helpdesk contact than mail)", "sliceName": "AppHelpDesk", "min": 0, "max": "1", "base": { "path": "CommunicationRequest.sender.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/Sender/AppHelpDesk-v2" } ] }, { "id": "CommunicationRequest.requester", "path": "CommunicationRequest.requester", "short": "Who/what is requesting service", "definition": "The individual who initiated the request and has responsibility for its activation.", "alias": [ "author" ], "min": 0, "max": "1", "base": { "path": "CommunicationRequest.requester", "min": 0, "max": "1" }, "type": [ { "code": "BackboneElement" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "cmr-1", "severity": "error", "human": "onBehalfOf can only be specified if agent is practitioner or device", "expression": "(agent.resolve() is Practitioner) or (agent.resolve() is Device) or onBehalfOf.exists().not()", "xpath": "contains(f:agent/f:reference/@value, '/Practitioner/') or contains(f:agent/f:reference/@value, '/Device/') or not(exists(f:onBehalfOf))" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "Request.requester" }, { "identity": "rim", "map": ".participation[typeCode=AUT].role" } ] }, { "id": "CommunicationRequest.requester.id", "path": "CommunicationRequest.requester.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "CommunicationRequest.requester.extension", "path": "CommunicationRequest.requester.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "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" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "CommunicationRequest.requester.modifierExtension", "path": "CommunicationRequest.requester.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.", "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", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "CommunicationRequest.requester.agent", "path": "CommunicationRequest.requester.agent", "short": "Individual making the request", "definition": "The device, practitioner, etc. who initiated the request.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (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": "CommunicationRequest.requester.agent", "min": 1, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" } ], "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": "Request.requester.agent" }, { "identity": "rim", "map": ".player" }, { "identity": "w5", "map": "who.author" } ] }, { "id": "CommunicationRequest.requester.onBehalfOf", "path": "CommunicationRequest.requester.onBehalfOf", "short": "Organization agent is acting for", "definition": "The organization the device or practitioner was acting on behalf of.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (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.", "requirements": "Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request.", "min": 0, "max": "1", "base": { "path": "CommunicationRequest.requester.onBehalfOf", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "condition": [ "ele-1", "cmr-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" } ], "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": "Request.requester.onBehalfOf" }, { "identity": "rim", "map": ".scoper" } ] }, { "id": "CommunicationRequest.reasonCode", "path": "CommunicationRequest.reasonCode", "short": "Why is communication needed?", "definition": "Describes why the request is being made in coded or textual form.", "comment": "Textual reasons can be caprued using reasonCode.text.", "min": 0, "max": "*", "base": { "path": "CommunicationRequest.reasonCode", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "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.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/v3-ActReason" } }, "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": "Request.reasonCode" }, { "identity": "rim", "map": ".reasonCode" }, { "identity": "w5", "map": "why" } ] }, { "id": "CommunicationRequest.reasonReference", "path": "CommunicationRequest.reasonReference", "short": "Why is communication needed?", "definition": "Indicates another resource whose existence justifies this request.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (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": "*", "base": { "path": "CommunicationRequest.reasonReference", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Observation" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" } ], "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": "Request.reasonReference" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=RSON].target" }, { "identity": "w5", "map": "why" } ] }, { "id": "CommunicationRequest.note", "path": "CommunicationRequest.note", "short": "Comments made about communication request", "definition": "Comments made about the request by the requester, sender, recipient, subject or other participants.", "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": "*", "base": { "path": "CommunicationRequest.note", "min": 0, "max": "*" }, "type": [ { "code": "Annotation" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Act" }, { "identity": "workflow", "map": "Request.note" }, { "identity": "rim", "map": ".inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]" } ] } ] }, "differential": { "element": [ { "id": "CommunicationRequest", "path": "CommunicationRequest", "constraint": [ { "key": "cmr-lifen-1", "severity": "error", "human": "The communication request with status active SHALL have a recipient, a sender and a category", "expression": "status != 'active' or (recipient.exists() and sender.exists() and category.exists())" }, { "key": "cmr-lifen-2", "severity": "error", "human": "The communication request with status active and category MEDICAL_REPORT SHALL have a payload", "expression": "status != 'active' or category.coding.code != 'MEDICAL_REPORT' or payload.exists()" }, { "key": "cmr-lifen-3", "severity": "error", "human": "The communication request with status active and category MEDICAL_REPORT_COLOR SHALL have a payload", "expression": "status != 'active' or category.coding.code != 'MEDICAL_REPORT_COLOR' or payload.exists()" }, { "key": "cmr-lifen-4", "severity": "error", "human": "The communication request with status active and category CANCELLATION_DOCUMENT SHALL have a payload", "expression": "status != 'active' or category.coding.code != 'CANCELLATION_DOCUMENT' or payload.exists()" } ] }, { "id": "CommunicationRequest.meta", "path": "CommunicationRequest.meta", "type": [ { "code": "Meta", "profile": "http://lifen.fr/fhir/StructureDefinition/LifenMetaCoreProfile-v2" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ] }, { "id": "CommunicationRequest.meta.tag", "path": "CommunicationRequest.meta.tag", "binding": { "strength": "required", "description": "LifenValueSetCommunicationRequestTag", "valueSetReference": { "reference": "http://lifen.fr/fhir/ValueSet/CommunicationRequest/Tags-v2" } } }, { "id": "CommunicationRequest.contained", "path": "CommunicationRequest.contained", "max": "0" }, { "id": "CommunicationRequest.extension:resendProcessed", "path": "CommunicationRequest.extension", "sliceName": "resendProcessed", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/ResendProcessed-v2" } ] }, { "id": "CommunicationRequest.extension:threadOrigin", "path": "CommunicationRequest.extension", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/ThreadOrigin-v2" } ] }, { "id": "CommunicationRequest.extension:messagingSubject", "path": "CommunicationRequest.extension", "sliceName": "messagingSubject", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/MessagingSubject-v2" } ] }, { "id": "CommunicationRequest.extension:automaticSending", "path": "CommunicationRequest.extension", "definition": "extension to enable automatic sending", "sliceName": "automaticSending", "min": 0, "max": "*", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/CommunicationRequest/Extension/AutomaticSending-v2" } ] }, { "id": "CommunicationRequest.extension:automaticSendingMainCron", "path": "CommunicationRequest.extension", "definition": "extension to enable automatic sending of the resource only on main cron (and not hourly, the default value)", "min": 0, "max": "1", "sliceName": "automaticSendingMainCron", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/CommunicationRequest/Extension/AutomaticSending-v2MainCron-v2" } ] }, { "id": "CommunicationRequest.extension:userVerificationNeededReason", "path": "CommunicationRequest.extension", "definition": "extension for user verification needed reason", "sliceName": "userVerificationNeededReason", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/CommunicationRequest/Extension/UserVerificationNeededReason-v2" } ] }, { "id": "CommunicationRequest.extension:skipDocTypeCheck", "path": "CommunicationRequest.extension", "definition": "extension to know if the document type check must be skipped", "min": 0, "max": "*", "sliceName": "skipDocTypeCheck", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/CommunicationRequest/Extension/SkipDocTypeCheck-v2" } ] }, { "id": "CommunicationRequest.extension:synchronousProcessing", "path": "CommunicationRequest.extension", "sliceName": "synchronousProcessing", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/CommunicationRequest/Extension/synchronousProcessing-v2" } ] }, { "id": "CommunicationRequest.extension:enrichmentManagedByBECA", "path": "CommunicationRequest.extension", "definition": "Specify if the enrichment of CommunicationRequest (ex. patient match) is done by BECA rather than legacy LFs", "min": 0, "max": "*", "sliceName": "enrichmentManagedByBECA", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/CommunicationRequest/Extension/EnrichmentManagedByBECA-v2" } ] }, { "id": "CommunicationRequest.extension:ENSStopConversationExtension", "path": "CommunicationRequest.extension", "sliceName": "ENSStopConversationExtension", "definition": "Specifies that the string of characters FIN has to be included to the SMTP header X-MSS-MES in the mail to the patient", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/ENSStopConversationExtension-v2" } ] }, { "id": "CommunicationRequest.extension:mailBodyTemplate", "path": "CommunicationRequest.extension", "sliceName": "mailBodyTemplate", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/MailBodyTemplate-v2" } ] }, { "id": "CommunicationRequest.extension:sourceApplicationName", "path": "CommunicationRequest.extension", "sliceName": "sourceApplicationName", "definition": "Specify a valueString to identify the application name that created the resource.", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/SourceApplicationName" } ] }, { "id": "CommunicationRequest.extension:SendingRequestId", "path": "CommunicationRequest.extension", "sliceName": "SendingRequestId", "definition": "Identifier of the sending request (from a business point of view) in order to follow the full cycle of a sending request whitout having to do secondary search (heavy in resource)", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/SendingRequestId-v2" } ] }, { "id": "CommunicationRequest.extension:databaseReference", "path": "CommunicationRequest.extension", "sliceName": "databaseReference", "definition": "extension databaseReference - relation between an healthcare structure and a third app", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/DatabaseReference-v2" } ] }, { "id": "CommunicationRequest.extension:IdReplacedDocumentNotSentWithLifen", "path": "CommunicationRequest.extension", "definition": "Give the id of a document that hasn’t been sent with Lifen (i.e. no DocumentReference available for it) that a client ask to replace through MSS and/or DMP", "sliceName": "IdReplacedDocumentNotSentWithLifen", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/CommunicationRequest/Extension/IdReplacedDocumentNotSentWithLifen-v2" } ] }, { "id": "CommunicationRequest.category", "path": "CommunicationRequest.category", "definition": "The type of message to be sent such as medical report, cancel, replacement, ...", "binding": { "strength": "required", "description": "Codes for general categories of communications such as cancel, replacement, ...", "valueSetReference": { "reference": "http://lifen.fr/fhir/ValueSet/Resource/Category-v2" } } }, { "id": "CommunicationRequest.recipient.extension", "path": "CommunicationRequest.recipient.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" } }, { "id": "CommunicationRequest.recipient.extension:recipientDetails", "path": "CommunicationRequest.recipient.extension", "sliceName": "recipientDetails", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/communicationrequest-recipient-details-v2" } ] }, { "id": "CommunicationRequest.recipient.extension:practitionerrole", "path": "CommunicationRequest.recipient.extension", "sliceName": "practitionerrole", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/PractitionerRole-v2" } ] }, { "id": "CommunicationRequest.recipient.extension:hl7information", "path": "CommunicationRequest.recipient.extension", "sliceName": "hl7information", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/CommunicationRequest/Extension/Recipient/HL7Information-v2" } ] }, { "id": "CommunicationRequest.recipient.extension:UnbillabilityReason", "path": "CommunicationRequest.recipient.extension", "sliceName": "UnbillabilityReason", "definition": "Indicates the reason why a communication is not billed to client", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/UnbillabilityReason-v2" } ] }, { "id": "CommunicationRequest.recipient.extension:RecipientId", "path": "CommunicationRequest.recipient.extension", "sliceName": "RecipientId", "definition": "Identifier of the sending operation in order to follow the full cycle of a sending request for one specific recipient whitout having to do secondary search (heavy in resource)", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/RecipientId-v2" } ] }, { "id": "CommunicationRequest.topic.extension", "path": "CommunicationRequest.topic.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" } }, { "id": "CommunicationRequest.topic.extension:type", "path": "CommunicationRequest.topic.extension", "sliceName": "type", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/Topic/Type-v2" } ] }, { "id": "CommunicationRequest.sender.extension", "path": "CommunicationRequest.sender.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ] }, { "id": "CommunicationRequest.sender.extension:practitionerrole", "path": "CommunicationRequest.sender.extension", "definition": "Sender extension to bind PractitionerRole associated to this sender", "sliceName": "practitionerrole", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/PractitionerRole-v2" } ] }, { "id": "CommunicationRequest.sender.extension:FromMailAdd", "path": "CommunicationRequest.sender.extension", "definition": "Mail address to be used in the field “from” of the mail", "sliceName": "FromMailAdd", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/Sender/FromMailAdd-v2" } ] }, { "id": "CommunicationRequest.sender.extension:AppHelpDesk", "path": "CommunicationRequest.sender.extension", "definition": "Help Desk Mail address of the application which was used to send a MSS mail (eventually might be used for other helpdesk contact than mail)", "sliceName": "AppHelpDesk", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/Sender/AppHelpDesk-v2" } ] }, { "id": "CommunicationRequest.payload.contentString.extension:contentType", "path": "CommunicationRequest.payload.contentString.extension", "sliceName": "contentType", "definition": "extension to specify contentString contentType", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": "http://lifen.fr/fhir/StructureDefinition/Resource/Extension/Payload/ContentString/ContentType-v2" } ] } ] } }