AU eRequesting Implementation Guide
0.3.0-preview - Preview Australia flag

This page is part of the AU eRequesting (v0.3.0-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions

Resource Profile: AUeRequestingCommunicationRequestCopyTo - Detailed Descriptions

Page standards status: Draft Maturity Level: 0

Definitions for the au-erequesting-communicationrequest-copyto resource profile.

Guidance on how to interpret the contents of this table can be found here

0. CommunicationRequest
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.

ShortA request for information to be sent to a receiver
Control0..*
Is Modifierfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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 (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())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. CommunicationRequest.implicitRules
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.

ShortA set of rules under which this content was created
Comments

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.

Control0..1
Typeuri
Is Modifiertrue because 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
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. CommunicationRequest.modifierExtension
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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
Comments

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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
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.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. CommunicationRequest.groupIdentifier
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.

ShortComposite request this is part of
Comments

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.

Control10..1
TypeIdentifier(AU Local Order Identifier)
Is Modifierfalse
Must Supporttrue
Obligations
    ObligationsActor
    SHALL:populateAU eRequesting Placer
    SHALL:handleAU eRequesting Filler
    SHALL:handleAU eRequesting Server
    SHALL:able-to-populateAU eRequesting Server
    SHALL:no-errorAU eRequesting Patient
    Summarytrue
    Alternate NamesgrouperId
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    8. CommunicationRequest.groupIdentifier.use
    Definition

    The purpose of this identifier.

    Shortusual | official | temp | secondary | old (If known)
    Comments

    Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

    Control0..1
    BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

    Identifies the purpose for this identifier, if known .

    Typecode
    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    10. CommunicationRequest.groupIdentifier.type
    Definition

    A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

    ShortCoded identifier type for local order identifierDescription of identifier
    Comments

    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.

    Control10..1
    BindingThe codes SHALL be taken from Unless not suitable, these codes SHALL be taken from Order Identifier Typehttp://hl7.org/fhir/ValueSet/identifier-type
    (required to http://terminology.hl7.org.au/ValueSet/order-identifier-type)
    TypeCodeableConcept
    Is Modifierfalse
    Summarytrue
    Requirements

    Allows users to make use of identifiers when the identifier system is not known.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    12. CommunicationRequest.groupIdentifier.type.coding
    Definition

    A reference to a code defined by a terminology system.

    ShortCode defined by a terminology system
    Comments

    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.

    Control10..1*
    TypeCoding
    Is Modifierfalse
    Summarytrue
    Requirements

    Allows for alternative encodings within a code system, and translations to other code systems.

    Pattern Value{
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "PGN"
    }
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. CommunicationRequest.groupIdentifier.system
    Definition

    Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

    ShortSystem identifier namespace for the organisation that assigned the order identifierThe namespace for the identifier value
    Comments

    Identifier.system is always case sensitive.

    Control10..1
    Typeuri
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    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.

    Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. CommunicationRequest.groupIdentifier.value
    Definition

    The portion of the identifier typically relevant to the user and which is unique within the context of the system.

    ShortOrder identifierThe value that is unique
    Comments

    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. 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.

    Control10..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Example<br/><b>General</b>:123456
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. CommunicationRequest.status
    Definition

    The status of the proposal or order.

    Shortdraft | active | on-hold | revoked | completed | entered-in-error | unknown
    Control1..1
    BindingThe codes SHALL be taken from RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1
    (required to http://hl7.org/fhir/ValueSet/request-status|4.0.1)

    The status of the communication request.

    Typecode
    Is Modifiertrue because 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.
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Obligations
      ObligationsActor
      SHALL:populateAU eRequesting Placer
      SHALL:handleAU eRequesting Filler
      SHALL:handleAU eRequesting Server
      SHALL:able-to-populateAU eRequesting Server
      SHALL:no-errorAU eRequesting Patient
      Summarytrue
      Fixed Valueactive
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      20. CommunicationRequest.category
      Definition

      The type of message to be sent such as alert, notification, reminder, instruction, etc.

      ShortMessage category
      Comments

      There may be multiple axes of categorization and one communication request may serve multiple purposes.

      Control10..1*
      BindingFor example codes, see CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-category
      (example to http://hl7.org/fhir/ValueSet/communication-category)

      Codes for general categories of communications such as alerts, instruction, etc.

      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Obligations
        ObligationsActor
        SHALL:populateAU eRequesting Placer
        SHALL:handleAU eRequesting Filler
        SHALL:handleAU eRequesting Server
        SHALL:able-to-populateAU eRequesting Server
        SHALL:no-errorAU eRequesting Patient
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        22. CommunicationRequest.category.coding
        Definition

        A reference to a code defined by a terminology system.

        ShortCode defined by a terminology system
        Comments

        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.

        Control10..1*
        TypeCoding
        Is Modifierfalse
        Summarytrue
        Requirements

        Allows for alternative encodings within a code system, and translations to other code systems.

        Pattern Value{
          "system" : "http://terminology.hl7.org/CodeSystem/communication-category",
          "code" : "notification"
        }
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        24. CommunicationRequest.doNotPerform
        Definition

        If true indicates that the CommunicationRequest is asking for the specified action to not occur.

        ShortTrue if request is prohibiting action
        Comments

        The attributes provided with the request qualify what is not to be done.

        Control0..01
        Typeboolean
        Is Modifiertrue because 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.
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Alternate Namesprohibited
        Meaning if MissingIf do not perform is not specified, the request is a positive request e.g. "do perform"
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        26. CommunicationRequest.subject
        Definition

        The patient or group that is the focus of this communication request.

        ShortPatient that is the subject of the diagnostic requestFocus of message
        Control10..1
        TypeReference(AU Core Patient, Patient, Group)
        Is Modifierfalse
        Must Supporttrue
        Obligations
          ObligationsActor
          SHALL:populateAU eRequesting Placer
          SHALL:handleAU eRequesting Filler
          SHALL:handleAU eRequesting Server
          SHALL:able-to-populateAU eRequesting Server
          SHALL:no-errorAU eRequesting Patient
          Summaryfalse
          Alternate Namespatient
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          28. CommunicationRequest.about
          Definition

          Other resources that pertain to this communication request and to which this communication request should be associated.

          ShortDiagnostic request the copy-to communication is aboutResources that pertain to this communication request
          Comments

          Don't use CommunicationRequest.about element when a more specific element exists, such as basedOn, reasonReference, or replaces.

          Control10..*
          TypeReference(AU eRequesting Pathology Request, AU eRequesting Imaging Request, Resource)
          Is Modifierfalse
          Must Supporttrue
          Must Support TypesNo must-support rules about the choice of types/profiles
          Obligations
            ObligationsActor
            SHALL:populateAU eRequesting Placer
            SHALL:handleAU eRequesting Filler
            SHALL:handleAU eRequesting Server
            SHALL:able-to-populateAU eRequesting Server
            SHALL:no-errorAU eRequesting Patient
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            30. CommunicationRequest.authoredOn
            Definition

            For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.

            ShortDate/time when communication request direction obtainedWhen request transitioned to being actionable
            Control10..1
            TypedateTime
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Obligations
              ObligationsActor
              SHALL:populateAU eRequesting Placer
              SHALL:handleAU eRequesting Filler
              SHALL:handleAU eRequesting Server
              SHALL:able-to-populateAU eRequesting Server
              SHALL:no-errorAU eRequesting Patient
              Summarytrue
              Alternate NamescreatedOn
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              32. CommunicationRequest.requester
              Definition

              The device, individual, or organization who initiated the request and has responsibility for its activation.

              ShortIndividual provider requesting the communicationWho/what is requesting service
              Control10..1
              TypeReference(AU Core PractitionerRole, Practitioner, PractitionerRole, Organization, Patient, RelatedPerson, Device)
              Is Modifierfalse
              Must Supporttrue
              Obligations
                ObligationsActor
                SHALL:populateAU eRequesting Placer
                SHALL:handleAU eRequesting Filler
                SHALL:handleAU eRequesting Server
                SHALL:able-to-populateAU eRequesting Server
                SHALL:no-errorAU eRequesting Patient
                Summarytrue
                Alternate Namesauthor
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                34. CommunicationRequest.recipient
                Definition

                The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.

                ShortIndividual provider or patient who is the intended recipient of the copyMessage recipient
                Control10..1*
                TypeReference(AU Core PractitionerRole, AU Core Patient, Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson, Group, CareTeam, HealthcareService)
                Is Modifierfalse
                Must Supporttrue
                Must Support TypesNo must-support rules about the choice of types/profiles
                Obligations
                  ObligationsActor
                  SHALL:populateAU eRequesting Placer
                  SHALL:handleAU eRequesting Filler
                  SHALL:handleAU eRequesting Server
                  SHALL:able-to-populateAU eRequesting Server
                  SHALL:no-errorAU eRequesting Patient
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  36. CommunicationRequest.sender
                  Definition

                  The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.

                  ShortDiagnostic organisation sending the communicationMessage sender
                  Control10..1
                  TypeReference(AU Core Organization, Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson, HealthcareService)
                  Is Modifierfalse
                  Must Supporttrue
                  Obligations
                    ObligationsActor
                    SHALL:populateAU eRequesting Placer
                    SHALL:handleAU eRequesting Filler
                    SHALL:handleAU eRequesting Server
                    SHALL:able-to-populateAU eRequesting Server
                    SHALL:no-errorAU eRequesting Patient
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    38. CommunicationRequest.reasonCode
                    Definition

                    Describes why the request is being made in coded or textual form.

                    ShortWhy is communication needed?
                    Comments

                    Textual reasons can be captured using reasonCode.text.

                    Control10..1*
                    BindingFor example codes, see v3 Code System ActReasonhttp://terminology.hl7.org/ValueSet/v3-ActReason
                    (example to http://terminology.hl7.org/ValueSet/v3-ActReason)

                    Codes for describing reasons for the occurrence of a communication.

                    TypeCodeableConcept
                    Is Modifierfalse
                    Must Supporttrue
                    Obligations
                      ObligationsActor
                      SHALL:populateAU eRequesting Placer
                      SHALL:handleAU eRequesting Filler
                      SHALL:handleAU eRequesting Server
                      SHALL:able-to-populateAU eRequesting Server
                      SHALL:no-errorAU eRequesting Patient
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      40. CommunicationRequest.reasonCode.coding
                      Definition

                      A reference to a code defined by a terminology system.

                      ShortCode defined by a terminology system
                      Comments

                      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.

                      Control10..1*
                      TypeCoding
                      Is Modifierfalse
                      Summarytrue
                      Requirements

                      Allows for alternative encodings within a code system, and translations to other code systems.

                      Pattern Value{
                        "system" : "http://hl7.org.au/fhir/ereq/CodeSystem/au-erequesting-communication-request-reason",
                        "code" : "copyto"
                      }
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))