{
"description": "This profile sets minimum expectations for a CommunicationRequest resource that is used to define a copy-to clinician or copy-to patient as a report recipient. This is differentiated from an urgent practitioner communication as priority may not be urgent and the requester will not be the recipient. It is based on the [CommunicationRequest](https://hl7.org/fhir/R4/communicationrequest.html) and identifies the additional constraints, extensions, vocabularies and value sets that SHALL be present in the CommunicationRequest when conforming to this profile.",
"_filename": "StructureDefinition-au-erequesting-communicationrequest-copyto.json",
"package_name": "hl7.fhir.au.ereq",
"date": "2025-03-12T04:23:30+00:00",
"derivation": "constraint",
"publisher": "HL7 Australia",
"fhirVersion": "4.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "AU",
"system": "urn:iso:std:iso:3166"
} ]
} ],
"name": "AUeRequestingCommunicationRequestCopyTo",
"mapping": [ {
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern",
"identity": "workflow"
}, {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"copyright": "Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2024+; Licensed Under Creative Commons No Rights Reserved.",
"type": "CommunicationRequest",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "AU eRequesting Communication Request CopyTo",
"package_version": "0.3.0-preview",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "draft",
"_valueCode": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ImplementationGuide/hl7.fhir.au.ereq"
} ]
}
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-5",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"xpath": "not(exists(f:contained/*/f:meta/f:security))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.security.empty()"
}, {
"key": "dom-6",
"human": "A resource should have narrative for robust management",
"xpath": "exists(f:text/h:div)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "warning",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
} ],
"expression": "text.`div`.exists()"
} ],
"path": "CommunicationRequest",
"min": 0,
"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.",
"isModifier": false,
"short": "A request for information to be sent to a receiver",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "Request",
"identity": "workflow"
} ],
"max": "*",
"id": "CommunicationRequest",
"base": {
"max": "*",
"min": 0,
"path": "CommunicationRequest"
},
"isSummary": false
}, {
"path": "CommunicationRequest.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"isModifier": false,
"short": "Logical id of this artifact",
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
} ]
} ],
"max": "1",
"id": "CommunicationRequest.id",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.meta",
"min": 0,
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"isModifier": false,
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "CommunicationRequest.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.implicitRules",
"min": 0,
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "CommunicationRequest.implicitRules",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"isModifier": false,
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/languages",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
} ],
"description": "A human language."
},
"max": "1",
"id": "CommunicationRequest.language",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"isModifier": false,
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "CommunicationRequest.text",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
},
"isSummary": false
}, {
"path": "CommunicationRequest.contained",
"min": 0,
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"isModifier": false,
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "CommunicationRequest.contained",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CommunicationRequest.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CommunicationRequest.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CommunicationRequest.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CommunicationRequest.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.identifier",
"requirements": "Allows identification of the communication request as it is known by various participating systems and in a way that remains consistent across servers.",
"min": 0,
"definition": "Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.",
"isModifier": false,
"short": "Unique identifier",
"mapping": [ {
"map": "Request.identifier",
"identity": "workflow"
}, {
"map": "FiveWs.identifier",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "*",
"id": "CommunicationRequest.identifier",
"comment": "This is a business identifier, not a resource identifier (see [discussion](http://hl7.org/fhir/R4/resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.",
"base": {
"max": "*",
"min": 0,
"path": "CommunicationRequest.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.basedOn",
"requirements": "Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon.",
"min": 0,
"definition": "A plan or proposal that is fulfilled in whole or in part by this request.",
"isModifier": false,
"short": "Fulfills plan or proposal",
"mapping": [ {
"map": "Request.basedOn",
"identity": "workflow"
}, {
"map": ".outboundRelationship[typeCode=FLFS].target",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"alias": [ "fulfills" ],
"max": "*",
"id": "CommunicationRequest.basedOn",
"base": {
"max": "*",
"min": 0,
"path": "CommunicationRequest.basedOn"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.replaces",
"requirements": "Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.",
"min": 0,
"definition": "Completed or terminated request(s) whose function is taken by this new request.",
"isModifier": false,
"short": "Request(s) replaced by this request",
"mapping": [ {
"map": "Request.replaces",
"identity": "workflow"
}, {
"map": ".outboundRelationship[typeCode=RPLC].target",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/CommunicationRequest" ]
} ],
"alias": [ "supersedes", "prior" ],
"max": "*",
"id": "CommunicationRequest.replaces",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "CommunicationRequest.replaces"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.groupIdentifier",
"min": 1,
"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.",
"isModifier": false,
"short": "Composite request this is part of",
"mapping": [ {
"map": "Request.groupIdentifier",
"identity": "workflow"
}, {
"map": ".inboundRelationship(typeCode=COMP].source[moodCode=INT].identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier",
"profile": [ "http://hl7.org.au/fhir/StructureDefinition/au-localorderidentifier" ]
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-placer"
}, {
"url": "code",
"valueCode": "SHALL:populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-filler"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:able-to-populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-patient"
}, {
"url": "code",
"valueCode": "SHALL:no-error"
} ]
} ],
"alias": [ "grouperId" ],
"max": "1",
"id": "CommunicationRequest.groupIdentifier",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "CommunicationRequest.groupIdentifier"
},
"isSummary": true
}, {
"path": "CommunicationRequest.groupIdentifier.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "CommunicationRequest.groupIdentifier.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CommunicationRequest.groupIdentifier.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CommunicationRequest.groupIdentifier.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.groupIdentifier.use",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min": 0,
"definition": "The purpose of this identifier.",
"isModifier": true,
"short": "usual | official | temp | secondary | old (If known)",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierUse"
} ],
"description": "Identifies the purpose for this identifier, if known ."
},
"max": "1",
"id": "CommunicationRequest.groupIdentifier.use",
"comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.use"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.groupIdentifier.type",
"requirements": "Allows users to make use of identifiers when the identifier system is not known.",
"min": 1,
"definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"isModifier": false,
"short": "Coded identifier type for local order identifier",
"mapping": [ {
"map": "CX.5",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org.au/ValueSet/order-identifier-type"
},
"max": "1",
"id": "CommunicationRequest.groupIdentifier.type",
"comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.type"
},
"isSummary": true
}, {
"path": "CommunicationRequest.groupIdentifier.type.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "CommunicationRequest.groupIdentifier.type.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CommunicationRequest.groupIdentifier.type.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CommunicationRequest.groupIdentifier.type.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.groupIdentifier.type.coding",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 1,
"definition": "A reference to a code defined by a terminology system.",
"isModifier": false,
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"max": "1",
"id": "CommunicationRequest.groupIdentifier.type.coding",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"patternCoding": {
"code": "PGN",
"system": "http://terminology.hl7.org/CodeSystem/v2-0203"
},
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.groupIdentifier.type.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"isModifier": false,
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "CommunicationRequest.groupIdentifier.type.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.groupIdentifier.system",
"requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
"min": 1,
"definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"isModifier": false,
"short": "System identifier namespace for the organisation that assigned the order identifier",
"mapping": [ {
"map": "CX.4 / EI-2-4",
"identity": "v2"
}, {
"map": "II.root or Role.id.root",
"identity": "rim"
}, {
"map": "./IdentifierType",
"identity": "servd"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "CommunicationRequest.groupIdentifier.system",
"comment": "Identifier.system is always case sensitive.",
"example": [ {
"label": "General",
"valueUri": "http://www.acme.com/identifiers/patient"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.system"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.groupIdentifier.value",
"min": 1,
"definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"isModifier": false,
"short": "Order identifier",
"mapping": [ {
"map": "CX.1 / EI.1",
"identity": "v2"
}, {
"map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)",
"identity": "rim"
}, {
"map": "./Value",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "CommunicationRequest.groupIdentifier.value",
"comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.",
"example": [ {
"label": "General",
"valueString": "123456"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.value"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.groupIdentifier.period",
"min": 0,
"definition": "Time period during which identifier is/was valid for use.",
"isModifier": false,
"short": "Time period when id is/was valid for use",
"mapping": [ {
"map": "CX.7 + CX.8",
"identity": "v2"
}, {
"map": "Role.effectiveTime or implied by context",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "CommunicationRequest.groupIdentifier.period",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.period"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.groupIdentifier.assigner",
"min": 0,
"definition": "Organization that issued/manages the identifier.",
"isModifier": false,
"short": "Organisation that assigned the order identifier",
"mapping": [ {
"map": "CX.4 / (CX.4,CX.9,CX.10)",
"identity": "v2"
}, {
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper",
"identity": "rim"
}, {
"map": "./IdentifierIssuingAuthority",
"identity": "servd"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"max": "1",
"id": "CommunicationRequest.groupIdentifier.assigner",
"comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.assigner"
},
"isSummary": true
}, {
"path": "CommunicationRequest.groupIdentifier.assigner.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "CommunicationRequest.groupIdentifier.assigner.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CommunicationRequest.groupIdentifier.assigner.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CommunicationRequest.groupIdentifier.assigner.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.groupIdentifier.assigner.reference",
"min": 0,
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"isModifier": false,
"short": "Literal reference, Relative, internal or absolute URL",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "CommunicationRequest.groupIdentifier.assigner.reference",
"condition": [ "ref-1" ],
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.reference"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.groupIdentifier.assigner.type",
"min": 0,
"definition": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"isModifier": false,
"short": "Type the reference refers to (e.g. \"Patient\")",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRResourceTypeExt"
} ],
"description": "Aa resource (or, for logical models, the URI of the logical model)."
},
"max": "1",
"id": "CommunicationRequest.groupIdentifier.assigner.type",
"comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.groupIdentifier.assigner.identifier",
"min": 0,
"definition": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"isModifier": false,
"short": "Logical reference, when literal reference is not known",
"mapping": [ {
"map": ".identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "1",
"id": "CommunicationRequest.groupIdentifier.assigner.identifier",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).",
"base": {
"max": "1",
"min": 0,
"path": "Reference.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.groupIdentifier.assigner.display",
"min": 1,
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"isModifier": false,
"short": "Name of the assigning organisation",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "CommunicationRequest.groupIdentifier.assigner.display",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.display"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.status",
"fixedCode": "active",
"min": 1,
"definition": "The status of the proposal or order.",
"isModifier": true,
"short": "draft | active | on-hold | revoked | completed | entered-in-error | unknown",
"mapping": [ {
"map": "Request.status",
"identity": "workflow"
}, {
"map": "FiveWs.status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-placer"
}, {
"url": "code",
"valueCode": "SHALL:populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-filler"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:able-to-populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-patient"
}, {
"url": "code",
"valueCode": "SHALL:no-error"
} ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/request-status|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationRequestStatus"
} ],
"description": "The status of the communication request."
},
"max": "1",
"id": "CommunicationRequest.status",
"base": {
"max": "1",
"min": 1,
"path": "CommunicationRequest.status"
},
"isModifierReason": "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid.",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.statusReason",
"min": 0,
"definition": "Captures the reason for the current state of the CommunicationRequest.",
"isModifier": false,
"short": "Reason for current status",
"mapping": [ {
"map": "Request.statusReason",
"identity": "workflow"
}, {
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationRequestStatusReason"
} ],
"description": "Codes identifying the reason for the current state of a request."
},
"alias": [ "Suspended Reason", "Cancelled Reason" ],
"max": "1",
"id": "CommunicationRequest.statusReason",
"comment": "This is generally only used for \"exception\" statuses such as \"suspended\" or \"cancelled\". The reason why the CommunicationRequest was created at all is captured in reasonCode, not here. [distinct reason codes for different statuses can be enforced using invariants if they are universal bindings].",
"base": {
"max": "1",
"min": 0,
"path": "CommunicationRequest.statusReason"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.category",
"min": 1,
"definition": "The type of message to be sent such as alert, notification, reminder, instruction, etc.",
"isModifier": false,
"short": "Message category",
"mapping": [ {
"map": "FiveWs.class",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-placer"
}, {
"url": "code",
"valueCode": "SHALL:populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-filler"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:able-to-populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-patient"
}, {
"url": "code",
"valueCode": "SHALL:no-error"
} ]
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/communication-category",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationCategory"
} ],
"description": "Codes for general categories of communications such as alerts, instruction, etc."
},
"max": "1",
"id": "CommunicationRequest.category",
"comment": "There may be multiple axes of categorization and one communication request may serve multiple purposes.",
"base": {
"max": "*",
"min": 0,
"path": "CommunicationRequest.category"
},
"isSummary": false
}, {
"path": "CommunicationRequest.category.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "CommunicationRequest.category.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CommunicationRequest.category.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CommunicationRequest.category.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.category.coding",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 1,
"definition": "A reference to a code defined by a terminology system.",
"isModifier": false,
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"max": "1",
"id": "CommunicationRequest.category.coding",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"patternCoding": {
"code": "notification",
"system": "http://terminology.hl7.org/CodeSystem/communication-category"
},
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.category.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"isModifier": false,
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "CommunicationRequest.category.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.priority",
"min": 0,
"definition": "Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.",
"isModifier": false,
"short": "routine | urgent | asap | stat",
"mapping": [ {
"map": "Request.priority",
"identity": "workflow"
}, {
"map": "FiveWs.grade",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"meaningWhenMissing": "If missing, this task should be performed with normal priority",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/request-priority|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationPriority"
} ],
"description": "Codes indicating the relative importance of a communication request."
},
"max": "1",
"id": "CommunicationRequest.priority",
"base": {
"max": "1",
"min": 0,
"path": "CommunicationRequest.priority"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.doNotPerform",
"min": 0,
"definition": "If true indicates that the CommunicationRequest is asking for the specified action to *not* occur.",
"isModifier": true,
"short": "True if request is prohibiting action",
"mapping": [ {
"map": "Request.doNotPerform",
"identity": "workflow"
} ],
"type": [ {
"code": "boolean"
} ],
"meaningWhenMissing": "If do not perform is not specified, the request is a positive request e.g. \"do perform\"",
"alias": [ "prohibited" ],
"max": "0",
"id": "CommunicationRequest.doNotPerform",
"comment": "The attributes provided with the request qualify what is not to be done.",
"base": {
"max": "1",
"min": 0,
"path": "CommunicationRequest.doNotPerform"
},
"isModifierReason": "If true this element negates the specified action. For Example, instead of a request for a communication, it is a request for the communication to not occur.",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.medium",
"min": 0,
"definition": "A channel that was used for this communication (e.g. email, fax).",
"isModifier": false,
"short": "A channel of communication",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ParticipationMode",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationMedium"
} ],
"description": "Codes for communication mediums such as phone, fax, email, in person, etc."
},
"max": "*",
"id": "CommunicationRequest.medium",
"base": {
"max": "*",
"min": 0,
"path": "CommunicationRequest.medium"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.subject",
"min": 1,
"definition": "The patient or group that is the focus of this communication request.",
"isModifier": false,
"short": "Patient that is the subject of the diagnostic request",
"mapping": [ {
"map": "Request.subject",
"identity": "workflow"
}, {
"map": "FiveWs.subject[x]",
"identity": "w5"
}, {
"map": "FiveWs.subject",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient" ]
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-placer"
}, {
"url": "code",
"valueCode": "SHALL:populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-filler"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:able-to-populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-patient"
}, {
"url": "code",
"valueCode": "SHALL:no-error"
} ]
} ],
"alias": [ "patient" ],
"max": "1",
"id": "CommunicationRequest.subject",
"base": {
"max": "1",
"min": 0,
"path": "CommunicationRequest.subject"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.about",
"min": 1,
"definition": "Other resources that pertain to this communication request and to which this communication request should be associated.",
"isModifier": false,
"short": "Diagnostic request the copy-to communication is about",
"mapping": [ {
"map": "Request.supportingInfo",
"identity": "workflow"
}, {
"map": "FiveWs.context",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-servicerequest-path", "http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-servicerequest-imag" ]
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-placer"
}, {
"url": "code",
"valueCode": "SHALL:populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-filler"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:able-to-populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-patient"
}, {
"url": "code",
"valueCode": "SHALL:no-error"
} ]
} ],
"max": "*",
"id": "CommunicationRequest.about",
"comment": "Don't use CommunicationRequest.about element when a more specific element exists, such as basedOn, reasonReference, or replaces.",
"base": {
"max": "*",
"min": 0,
"path": "CommunicationRequest.about"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.encounter",
"min": 0,
"definition": "The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.",
"isModifier": false,
"short": "Encounter created as part of",
"mapping": [ {
"map": "Request.context",
"identity": "workflow"
}, {
"map": "FiveWs.context",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Encounter" ]
} ],
"max": "1",
"id": "CommunicationRequest.encounter",
"comment": "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.",
"base": {
"max": "1",
"min": 0,
"path": "CommunicationRequest.encounter"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.payload",
"min": 0,
"definition": "Text, attachment(s), or resource(s) to be communicated to the recipient.",
"isModifier": false,
"short": "Message payload",
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "CommunicationRequest.payload",
"base": {
"max": "*",
"min": 0,
"path": "CommunicationRequest.payload"
},
"isSummary": false
}, {
"path": "CommunicationRequest.payload.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "CommunicationRequest.payload.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CommunicationRequest.payload.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CommunicationRequest.payload.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CommunicationRequest.payload.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "CommunicationRequest.payload.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.payload.content[x]",
"min": 1,
"definition": "The communicated content (or for multi-part communications, one portion of the communication).",
"isModifier": false,
"short": "Message part content",
"mapping": [ {
"map": "Request.note",
"identity": "workflow"
} ],
"type": [ {
"code": "string"
}, {
"code": "Attachment"
}, {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"max": "1",
"id": "CommunicationRequest.payload.content[x]",
"base": {
"max": "1",
"min": 1,
"path": "CommunicationRequest.payload.content[x]"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.occurrence[x]",
"min": 0,
"definition": "The time when this communication is to occur.",
"isModifier": false,
"short": "When scheduled",
"mapping": [ {
"map": "Request.occurrence[x]",
"identity": "workflow"
}, {
"map": "FiveWs.planned",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
}, {
"code": "Period"
} ],
"alias": [ "timing" ],
"max": "1",
"id": "CommunicationRequest.occurrence[x]",
"base": {
"max": "1",
"min": 0,
"path": "CommunicationRequest.occurrence[x]"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.authoredOn",
"min": 1,
"definition": "For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.",
"isModifier": false,
"short": "Date/time when communication request direction obtained",
"mapping": [ {
"map": "Request.authoredOn",
"identity": "workflow"
}, {
"map": "FiveWs.recorded",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-placer"
}, {
"url": "code",
"valueCode": "SHALL:populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-filler"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:able-to-populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-patient"
}, {
"url": "code",
"valueCode": "SHALL:no-error"
} ]
} ],
"alias": [ "createdOn" ],
"max": "1",
"id": "CommunicationRequest.authoredOn",
"base": {
"max": "1",
"min": 0,
"path": "CommunicationRequest.authoredOn"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.requester",
"min": 1,
"definition": "The device, individual, or organization who initiated the request and has responsibility for its activation.",
"isModifier": false,
"short": "Individual provider requesting the communication",
"mapping": [ {
"map": "Request.requester",
"identity": "workflow"
}, {
"map": "FiveWs.author",
"identity": "w5"
}, {
"map": ".participation[typeCode=AUT].role",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitionerrole" ]
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-placer"
}, {
"url": "code",
"valueCode": "SHALL:populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-filler"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:able-to-populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-patient"
}, {
"url": "code",
"valueCode": "SHALL:no-error"
} ]
} ],
"alias": [ "author" ],
"max": "1",
"id": "CommunicationRequest.requester",
"base": {
"max": "1",
"min": 0,
"path": "CommunicationRequest.requester"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.recipient",
"min": 1,
"definition": "The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.",
"isModifier": false,
"short": "Individual provider or patient who is the intended recipient of the copy",
"mapping": [ {
"map": "Request.performer",
"identity": "workflow"
}, {
"map": "FiveWs.actor",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitionerrole", "http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient" ]
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-placer"
}, {
"url": "code",
"valueCode": "SHALL:populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-filler"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:able-to-populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-patient"
}, {
"url": "code",
"valueCode": "SHALL:no-error"
} ]
} ],
"max": "1",
"id": "CommunicationRequest.recipient",
"base": {
"max": "*",
"min": 0,
"path": "CommunicationRequest.recipient"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.sender",
"min": 1,
"definition": "The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.",
"isModifier": false,
"short": "Diagnostic organisation sending the communication",
"mapping": [ {
"map": "Request.performer",
"identity": "workflow"
}, {
"map": "FiveWs.actor",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org.au/fhir/core/StructureDefinition/au-core-organization" ]
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-placer"
}, {
"url": "code",
"valueCode": "SHALL:populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-filler"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:able-to-populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-patient"
}, {
"url": "code",
"valueCode": "SHALL:no-error"
} ]
} ],
"max": "1",
"id": "CommunicationRequest.sender",
"base": {
"max": "1",
"min": 0,
"path": "CommunicationRequest.sender"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.reasonCode",
"min": 1,
"definition": "Describes why the request is being made in coded or textual form.",
"isModifier": false,
"short": "Why is communication needed?",
"mapping": [ {
"map": "Request.reasonCode",
"identity": "workflow"
}, {
"map": "FiveWs.why[x]",
"identity": "w5"
}, {
"map": ".reasonCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-placer"
}, {
"url": "code",
"valueCode": "SHALL:populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-filler"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:able-to-populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-patient"
}, {
"url": "code",
"valueCode": "SHALL:no-error"
} ]
} ],
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActReason",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationReason"
} ],
"description": "Codes for describing reasons for the occurrence of a communication."
},
"max": "1",
"id": "CommunicationRequest.reasonCode",
"comment": "Textual reasons can be captured using reasonCode.text.",
"base": {
"max": "*",
"min": 0,
"path": "CommunicationRequest.reasonCode"
},
"isSummary": true
}, {
"path": "CommunicationRequest.reasonCode.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "CommunicationRequest.reasonCode.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CommunicationRequest.reasonCode.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CommunicationRequest.reasonCode.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.reasonCode.coding",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 1,
"definition": "A reference to a code defined by a terminology system.",
"isModifier": false,
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"max": "1",
"id": "CommunicationRequest.reasonCode.coding",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"patternCoding": {
"code": "copyto",
"system": "http://hl7.org.au/fhir/ereq/CodeSystem/au-erequesting-communication-request-reason"
},
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.reasonCode.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"isModifier": false,
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "CommunicationRequest.reasonCode.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.reasonReference",
"min": 0,
"definition": "Indicates another resource whose existence justifies this request.",
"isModifier": false,
"short": "Why is communication needed?",
"mapping": [ {
"map": "Request.reasonReference",
"identity": "workflow"
}, {
"map": "FiveWs.why[x]",
"identity": "w5"
}, {
"map": ".outboundRelationship[typeCode=RSON].target",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Condition", "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/DiagnosticReport", "http://hl7.org/fhir/StructureDefinition/DocumentReference" ]
} ],
"max": "*",
"id": "CommunicationRequest.reasonReference",
"base": {
"max": "*",
"min": 0,
"path": "CommunicationRequest.reasonReference"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CommunicationRequest.note",
"min": 0,
"definition": "Comments made about the request by the requester, sender, recipient, subject or other participants.",
"isModifier": false,
"short": "Comments made about communication request",
"mapping": [ {
"map": "Request.note",
"identity": "workflow"
}, {
"map": ".inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]",
"identity": "rim"
} ],
"type": [ {
"code": "Annotation"
} ],
"max": "*",
"id": "CommunicationRequest.note",
"base": {
"max": "*",
"min": 0,
"path": "CommunicationRequest.note"
},
"isSummary": false
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.1"
} ]
},
"status": "draft",
"id": "3d065843-0f31-4515-a6b4-bf253e4d8bd0",
"kind": "resource",
"url": "http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-communicationrequest-copyto",
"version": "0.3.0-preview",
"differential": {
"element": [ {
"id": "CommunicationRequest",
"path": "CommunicationRequest"
}, {
"id": "CommunicationRequest.groupIdentifier",
"min": 1,
"path": "CommunicationRequest.groupIdentifier",
"type": [ {
"code": "Identifier",
"profile": [ "http://hl7.org.au/fhir/StructureDefinition/au-localorderidentifier" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-placer"
}, {
"url": "code",
"valueCode": "SHALL:populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-filler"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:able-to-populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-patient"
}, {
"url": "code",
"valueCode": "SHALL:no-error"
} ]
} ],
"mustSupport": true
}, {
"id": "CommunicationRequest.groupIdentifier.type.coding",
"max": "1",
"min": 1,
"path": "CommunicationRequest.groupIdentifier.type.coding",
"patternCoding": {
"code": "PGN",
"system": "http://terminology.hl7.org/CodeSystem/v2-0203"
}
}, {
"id": "CommunicationRequest.status",
"path": "CommunicationRequest.status",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-placer"
}, {
"url": "code",
"valueCode": "SHALL:populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-filler"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:able-to-populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-patient"
}, {
"url": "code",
"valueCode": "SHALL:no-error"
} ]
} ],
"fixedCode": "active",
"mustSupport": true
}, {
"id": "CommunicationRequest.category",
"max": "1",
"min": 1,
"path": "CommunicationRequest.category",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-placer"
}, {
"url": "code",
"valueCode": "SHALL:populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-filler"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:able-to-populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-patient"
}, {
"url": "code",
"valueCode": "SHALL:no-error"
} ]
} ],
"mustSupport": true
}, {
"id": "CommunicationRequest.category.coding",
"max": "1",
"min": 1,
"path": "CommunicationRequest.category.coding",
"patternCoding": {
"code": "notification",
"system": "http://terminology.hl7.org/CodeSystem/communication-category"
}
}, {
"id": "CommunicationRequest.doNotPerform",
"max": "0",
"path": "CommunicationRequest.doNotPerform"
}, {
"id": "CommunicationRequest.subject",
"min": 1,
"path": "CommunicationRequest.subject",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient" ]
} ],
"short": "Patient that is the subject of the diagnostic request",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-placer"
}, {
"url": "code",
"valueCode": "SHALL:populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-filler"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:able-to-populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-patient"
}, {
"url": "code",
"valueCode": "SHALL:no-error"
} ]
} ],
"mustSupport": true
}, {
"id": "CommunicationRequest.about",
"min": 1,
"path": "CommunicationRequest.about",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-servicerequest-path", "http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-servicerequest-imag" ]
} ],
"short": "Diagnostic request the copy-to communication is about",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-placer"
}, {
"url": "code",
"valueCode": "SHALL:populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-filler"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:able-to-populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-patient"
}, {
"url": "code",
"valueCode": "SHALL:no-error"
} ]
} ],
"mustSupport": true
}, {
"id": "CommunicationRequest.authoredOn",
"min": 1,
"path": "CommunicationRequest.authoredOn",
"short": "Date/time when communication request direction obtained",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-placer"
}, {
"url": "code",
"valueCode": "SHALL:populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-filler"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:able-to-populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-patient"
}, {
"url": "code",
"valueCode": "SHALL:no-error"
} ]
} ],
"mustSupport": true
}, {
"id": "CommunicationRequest.requester",
"min": 1,
"path": "CommunicationRequest.requester",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitionerrole" ]
} ],
"short": "Individual provider requesting the communication",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-placer"
}, {
"url": "code",
"valueCode": "SHALL:populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-filler"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:able-to-populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-patient"
}, {
"url": "code",
"valueCode": "SHALL:no-error"
} ]
} ],
"mustSupport": true
}, {
"id": "CommunicationRequest.recipient",
"max": "1",
"min": 1,
"path": "CommunicationRequest.recipient",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitionerrole", "http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient" ]
} ],
"short": "Individual provider or patient who is the intended recipient of the copy",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-placer"
}, {
"url": "code",
"valueCode": "SHALL:populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-filler"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:able-to-populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-patient"
}, {
"url": "code",
"valueCode": "SHALL:no-error"
} ]
} ],
"mustSupport": true
}, {
"id": "CommunicationRequest.sender",
"min": 1,
"path": "CommunicationRequest.sender",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org.au/fhir/core/StructureDefinition/au-core-organization" ]
} ],
"short": "Diagnostic organisation sending the communication",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-placer"
}, {
"url": "code",
"valueCode": "SHALL:populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-filler"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:able-to-populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-patient"
}, {
"url": "code",
"valueCode": "SHALL:no-error"
} ]
} ],
"mustSupport": true
}, {
"id": "CommunicationRequest.reasonCode",
"max": "1",
"min": 1,
"path": "CommunicationRequest.reasonCode",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-placer"
}, {
"url": "code",
"valueCode": "SHALL:populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-filler"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:handle"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-server"
}, {
"url": "code",
"valueCode": "SHALL:able-to-populate"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "actor",
"valueCanonical": "http://hl7.org.au/fhir/ereq/ActorDefinition/au-erequesting-actor-patient"
}, {
"url": "code",
"valueCode": "SHALL:no-error"
} ]
} ],
"mustSupport": true
}, {
"id": "CommunicationRequest.reasonCode.coding",
"max": "1",
"min": 1,
"path": "CommunicationRequest.reasonCode.coding",
"patternCoding": {
"code": "copyto",
"system": "http://hl7.org.au/fhir/ereq/CodeSystem/au-erequesting-communication-request-reason"
}
} ]
},
"contact": [ {
"name": "HL7 Australia",
"telecom": [ {
"value": "https://confluence.hl7.org/display/HAFWG",
"system": "url"
} ]
}, {
"name": "HL7 Australia FHIR Work Group",
"telecom": [ {
"use": "work",
"value": "https://confluence.hl7.org/display/HAFWG",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/CommunicationRequest"
}